docs(nav): nest the Getting Started chapters and flatten REFERENCE - #590
Open
breimanntools wants to merge 1 commit into
Open
breimanntools wants to merge 1 commit into
breimanntools wants to merge 1 commit into
Conversation
Getting Started listed its four notebooks above the first heading, so they
read as a loose list rather than as part of the Quick start they belong
to. They are now the sub-chapters of Quick start, and the ecosystem map,
which used to sit beside Getting Started in the OVERVIEW group, is its
closing chapter:
Getting Started
Quick start
A minimal CPP analysis
Quick start with AAanalysis
Slow start with AAanalysis
Plotting Prelude
The two APIs
Decision Map
The AAanalysis Ecosystem
Ecosystem map
A toctree takes its sidebar position from where it sits in the file, and a
section heading captures everything after it, so "last and at the top
level" is only expressible as a section of its own. Hence the short
closing section, which says what the map covers and links to it.
REFERENCE had seven top-level chapters, four of which were pages nobody
would look for on their own. It now has five: Beta Features moves under
API, since it qualifies the API surface rather than standing beside it,
and Data Tables and Data Schemas move under a new Data chapter that
introduces both and says which one answers which question - what ships
with the package, versus what the frames it returns contain.
Verified on a full build: no toctree warnings, nothing orphaned, and the
rendered sidebar matches the tree above.
Co-Authored-By: Claude Fable 5.1 <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #590 +/- ##
=======================================
Coverage 95.39% 95.39%
=======================================
Files 222 222
Lines 23387 23387
Branches 4073 4073
=======================================
Hits 22309 22309
Misses 631 631
Partials 447 447 see 2 files with indirect coverage changes
🚀 New features to boost your workflow:
|
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
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.
Two navigation fixes, both verified by parsing the rendered sidebar rather than by reading the source.
Getting Started
The four notebooks were listed above the first heading, so they read as a loose list rather than as part of the Quick start they belong to. They are now its sub-chapters, and the ecosystem map — which sat beside Getting Started in the OVERVIEW group — is its closing chapter:
A toctree takes its sidebar position from where it sits in the file, and a section heading captures everything after it — so "last and at the top level" is only expressible as a section of its own. Hence the short closing section, which says what the map covers and links to it.
REFERENCE: seven top-level chapters down to five
Beta Features moves under API, since it qualifies the API surface rather than standing beside it. Data Tables and Data Schemas move under a new Data chapter that introduces both and says which answers which question: what ships with the package, versus what the frames it returns contain.
Full build: no toctree warnings, nothing orphaned, and the rendered sidebar matches the tree above.
🤖 Generated with Claude Code