docs: reorganize toctree — merge how-tos/TinyMCE into Concepts, move app docs into References#38692
docs: reorganize toctree — merge how-tos/TinyMCE into Concepts, move app docs into References#38692robrap wants to merge 3 commits into
Conversation
…app docs into References
- Rename "Concepts and Guides" section to "Concepts and \"How-To\" Guides"
- Move how-tos (celery, use_the_api) and TinyMCE plugins into Concepts toctree (flat)
- Delete docs/how-tos/ directory; add redirects.txt entries for moved pages
- Move generated app index and app ADR index into docs/references/ as sibling items
("docs - App index", "docs - App ADR index") alongside the existing "docs - tree"
- Update conf.py and repository_docs.py output paths and titles accordingly
- Update docs/index.rst hidden toctree and grid cards to match new structure
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Note: This file is meant to be temporary.
The early-return guard in _create_index_rst_file skipped writing when the file already existed, so incremental builds kept a stale title. Now the guard only applies when using the default (directory-name) title; an explicit title always overwrites so the generated heading stays in sync. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…index Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Claude review (and fixes), so this doesn't need be duplicated. Now we just need a human author and a human reviewer. Overview Restructures the Sphinx/ReadTheDocs sidebar tree:
Correctness
Issues
Security / performance None applicable — pure documentation change, no runtime code paths affected. Recommendation Block on: a successful cd docs && make html with no new orphan-document or toctree-reference warnings before Required before merge: delete docs/decisions/toctree-reorganization-plan.md. |
WARNING:
Pre-merge action item
docs/decisions/toctree-reorganization-plan.md— it is a planning artifact, not an ADR. The before/after and rationale are documented in this PR description. Shipping it mixes.mdwith the.rstADR convention and sets an unwanted precedent.Summary
docs/references/as sibling items (docs - App index,docs - App ADR index) alongside the existingdocs - treedocs/how-tos/directory; addredirects.txtentries for moved pagesconf.py,repository_docs.py, toctree files, and grid cards to match new structure_create_index_rst_filenow overwrites the root index when a custom title is provided (previously bailed on first build's file, keeping a stale title)Plan
See
docs/decisions/toctree-reorganization-plan.mdfor the full before/after and rationale.Before / After (sidebar toctree)
Test plan
cd docs && make htmlbuilds without orphan-document warningsdocs - App ADR index,docs - App index,docs - treeas sibling items under References🤖 Generated with Claude Code