docs(readme): navigable index and tier-1 structure - #21
Merged
Conversation
Add a Table of Contents with GitHub-style #anchor links after the intro and before Installation, nesting each Quickstart's sub-sections. Existing heading hierarchy was already consistent (one H1, ## sections, ### sub-sections); no prose or code examples were changed. 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 opened with the title, logo, and intro, then dropped straight into a long, flat run of sections — two
Quickstartblocks each with many###sub-sections (Adaptive Stealth Mode, POST/PUT, Concurrency, Extract, Batch upload/estimate/retry/download/webhooks/error handling). With no index, a reader had to scroll the full ~450 lines to discover what the SDK covered or to jump to a specific capability.After: A
## Table of Contentssits directly after the intro and before Installation, linking every section and sub-section via GitHub-style#anchorlinks, with the Quickstart sub-sections nested under their parents.