docs: add a table of contents to the README - #30
Merged
Merged
Conversation
Promotes the bold feature and API group labels into real headings (a new Features section with 16 subsections, and headed API groups) since GitHub only anchors headings, then adds a complete Contents section. Every ToC link is verified against generated GitHub slugs, including the -1 suffixes for names that appear in both Features and the API reference.
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.
Summary
Adds a Contents section to the README. Since GitHub only generates anchors for headings and the entire feature walkthrough used bold
**Label.**paragraphs, those are promoted to real headings first:## Featuressection with 16###subsections (Nullable vs optional through Tuples), replacing the bold-paragraph run that lived under Basic Examples.### Parse and validate/### Safe parsing.###headings, with their parenthetical qualifiers converted to lead-in sentences.The ToC lists all 36 headings. Link correctness is script-verified: every anchor was checked against slugs generated with GitHub's rules from the actual headings, including the
-1suffixes for the four names that appear in both Features and API (Tuples,Object algebra,Serialization,JSON Schema).Content is otherwise unchanged; only label formatting and the lead-in sentences for former parentheticals were touched.