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.

Sign up for GitHub

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

Jump to bottom

[RFC] Link checker for documentation #1019

Open
pedro-psb opened this issue Oct 26, 2023 · 0 comments
Open

[RFC] Link checker for documentation #1019

pedro-psb opened this issue Oct 26, 2023 · 0 comments
Labels
good first issue Not a Bug Not a Problem, expected behavior RFC
Milestone
Backlog

Comments

@pedro-psb
Copy link
Member

Is your feature request related to a problem? Please describe.
Often internal links can be misspelled or external links be down.

Describe the solution you'd like
Implement a link checker for the documentation. The fixing of the links could still be manual.

Also, we could try to incorporate it to make all and CI and see if it produces reliable output.

Describe alternatives you've considered
None.

Additional context
Mkdocs have a simple internal link validation, but maybe some third part can be used instead( or along with it) for external links.
@pedro-psb pedro-psb added Not a Bug Not a Problem, expected behavior RFC good first issue labels Oct 26, 2023
@pedro-psb pedro-psb added this to the backlog milestone Oct 26, 2023
@pedro-psb pedro-psb modified the milestones: backlog, Backlog Nov 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Not a Bug Not a Problem, expected behavior RFC
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
1 participant
@pedro-psb