Repository navigation
docs(readme): add a table of contents - #63
Merged
Merged
Conversation
Fifteen sections and no way to jump to one -- add anchored links right after the intro so a reader can go straight to what they need.
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
1 participant
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.
What does this change?
Adds a table of contents right after the intro, linking to all 15 sections of the README so a reader can jump straight to what they need.
How was it verified?
Anchors were generated from the exact
##headers in the file (checked with grep), so each link matches GitHub's auto-generated anchor.Checklist
ruff check .passespytestpassesnpm run lintandnpm run buildpass, if the frontend changed