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

Validate anchors #3433

Open
pepopowitz opened this issue Mar 7, 2024 · 0 comments
Open

Validate anchors #3433

pepopowitz opened this issue Mar 7, 2024 · 0 comments
Assignees
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

pepopowitz commented Mar 7, 2024

Update: with #4799 merged, we can now take advantage of the anchor validation that Docusaurus is already doing.

Our docusaurus configuration currently treats broken anchor's as warnings. We can add the setting onBrokenAnchors: "throw" to treat them as errors.

And then we'd have to fix several hundred broken anchors (according to the most recent build) 😅 .


Old description

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
@pepopowitz pepopowitz moved this from 🆕 Inbox to 🔖 Ready in Developer Experience Mar 7, 2024
@jonathanlukas jonathanlukas mentioned this issue Mar 8, 2024
9 tasks
@pepopowitz pepopowitz moved this from 🔖 Ready to 📋 Backlog in Developer Experience Apr 26, 2024
@pepopowitz pepopowitz changed the title Validate anchors on internal link-checking Validate anchors Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Status: 📋 Backlog
Development

Successfully merging a pull request may close this issue.

1 participant