docs(readme): navigable index and tier-1 structure - #28
Merged
Conversation
Add a Table of Contents with GitHub-style #anchor links right after the intro, nesting sub-sections under Usage. No prose, code, badges, or section content changed — navigation only. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015rnxtANUejeRhQcGcftzsu
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.
Before: The README opens with the logo, title, and a one-line intro, then drops straight into
## Installationand a long run of sections — Usage with several sub-sections (Adaptive Stealth Mode, POST Requests, Extract, Batch, Concurrency and their nested notes), Examples, Contributing, License. A reader landing on the page has no map: to find "Batch" or the TypeScript note onPromise.allSettled()they have to scroll the whole document and scan every heading.After: A
## Table of Contentssits right below the intro, before Installation. It lists every top-level section as a GitHub-anchor link, with Usage's sub-sections nested underneath (and the Batch/Concurrency notes nested one level deeper).