Repository navigation
fix(docs): correct broken anchor links in README and contributor guides - #5839
Open
maithili39 wants to merge 1 commit into
Open
maithili39 wants to merge 1 commit into
maithili39 wants to merge 1 commit into
Conversation
Four in-repo anchor links pointed at headings that don't exist, so they silently do nothing when clicked on GitHub: - README.md's table of contents linked to #including-vanilla-in-your-project-via-npm, but the heading is "Including Vanilla in your project via NPM or yarn". The link text is updated to match the heading as well. - guides/release-process.md's own table of contents linked to #react-components instead of #releasing-react-components. - CONTRIBUTING.md linked to #deploy-vanillaframeworkio and #react-components in guides/release-process.md, whose headings slugify to #deploying-vanillaframeworkio and #releasing-react-components.
|
maithili39 is not a collaborator of the repo |
This branch has not been deployed
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Four table-of-contents links in the repo's own documentation point at anchors that don't exist, so clicking them on GitHub silently does nothing.
README.mdlinks to#including-vanilla-in-your-project-via-npm, but the heading is "Including Vanilla in your project via NPM or yarn", which slugifies to#including-vanilla-in-your-project-via-npm-or-yarn. I updated the link text to match the heading as well.guides/release-process.md's own contents list links to#react-components; the heading "Releasing React Components" slugifies to#releasing-react-components.CONTRIBUTING.mdlinks to#deploy-vanillaframeworkioand#react-componentsinguides/release-process.md; those headings are#deploying-vanillaframeworkioand#releasing-react-components.Docs only, no Sass or template changes.
prettier -cpasses on all three files.Related but deliberately left out:
guides/hacking.md's contents list links to#via-dotrunand#via-docker, but "Running the project" is a single section with no such subheadings. That needs a maintainer's call on whether to add the headings or drop the entries, and #5701 is already editing that file. Happy to follow up separately.