Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add template-only markdown link linter. #214

Open
anybodys opened this issue Dec 8, 2023 · 0 comments
Open

Add template-only markdown link linter. #214

anybodys opened this issue Dec 8, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@anybodys
Copy link
Contributor

anybodys commented Dec 8, 2023

Problem

Links in markdown documentation can break as updates are made and it's difficult to track them all down to fix.

Solution

Add a linter that will check markdown files for broken links, along the lines of navapbc/template-infra#497

Since the infra template already had this linter, this template should use a "template-only" linter. That will work for this template but avoid having duplicate linters when the application template is used with the infra template.

Alternatives

Because this was already adopted in infra, we should use the same solution and not explore alternatives, unless we want to change all the templates.

Additional Context

navapbc/template-application-nextjs#264

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant