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

Validate anchors on internal link-checking #3433

Open
pepopowitz opened this issue Mar 7, 2024 · 0 comments · May be fixed by #3442
Open

Validate anchors on internal link-checking #3433

pepopowitz opened this issue Mar 7, 2024 · 0 comments · May be fixed by #3442
Assignees
@pepopowitz
Labels
dx Documentation infrastructure typically handled by the Camunda DX team kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)

Comments

@pepopowitz
Copy link
Collaborator

We are currently using untitaker/hyperlink to check internal links. It is only validating that a target page exists.

We should consider validating anchors, too. There is a --check-anchors option to enable this.

Turning this flag on might open Pandora's box of invalid links, so be prepared for this work to include fixing a lot of existing links.
@pepopowitz pepopowitz added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) dx Documentation infrastructure typically handled by the Camunda DX team labels Mar 7, 2024
@pepopowitz pepopowitz self-assigned this Mar 7, 2024
@jonathanlukas jonathanlukas linked a pull request Mar 8, 2024 that will close this issue
Open
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pepopowitz pepopowitz

Labels
dx Documentation infrastructure typically handled by the Camunda DX team kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)
Projects
Developer Experience
Status: 📋 Backlog
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Enable check-anchors camunda/camunda-docs
1 participant
@pepopowitz