chore(): set onBrokenAnchors to 'throw' and fix all errors
#1329
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alicewriteswrongs
requested review from
christian-bromann and
tanner-reits
and removed request for
a team
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
tanner-reits
approved these changes
Jan 24, 2024
christian-bromann
approved these changes
Jan 24, 2024
This sets the `onBrokenAnchors` option for our Docusaurus config and then fixes all of the build errors that it surfaced. These mostly had to do with casing issues, like `#formAssociated` should be `#formassociated`. STENCIL-1096
alicewriteswrongs
force-pushed
the
ap/anchors
branch
from
bca23fb to
296a581
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docusaurus has an option called
onBrokenAnchorswhich, as the name suggests, controls how it should handle anchors which do not resolve to a heading in the page to which they link.This sets the option to
throw, so that the build will fail if we have a broken anchor on a link.It turns out we have quite a few! So this PR also fixes them.
A neat think is that it will even check the
toprop of Docusaurus' built-in<Link>component in a React component, which caught a typo on our lifecycle methods chart. Neat!