Validate anchors #3433
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)
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.
The text was updated successfully, but these errors were encountered: