docs: Cross-link the guide and the topic index - #2784
Draft
ericholscher wants to merge 3 commits into
Draft
ericholscher wants to merge 3 commits into
ericholscher wants to merge 3 commits into
Conversation
Where the documentation guide covers a topic, the topic index now links to it at the top of that section, so readers browsing talks and articles can find the written guidance too. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0192eR5sFokw734d1pJbMbE5
Each guide page that has a matching section in the content archive now ends with a pointer to that section's talks and newsletter articles. The topic sections get explicit labels so the links don't depend on generated anchors. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0192eR5sFokw734d1pJbMbE5
Enables sphinx.ext.autosectionlabel with document prefixes so any heading can be cross-referenced by its text, and drops the explicit labels added to the topic index. Duplicate-label warnings are suppressed because many pages repeat headings like "Membership" or "Example" within one document. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0192eR5sFokw734d1pJbMbE5
Documentation build overview
35 files changed ·
|
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.
The documentation guide and the content archive cover many of the same topics but never pointed at each other. A reader on the guide's style-guides page had no way to find the dozens of talks and newsletter articles on style guides, and a reader browsing the topic index never learned the guide existed. This links them in both directions as a first step, without changing how either is maintained.
Where the guide covers a topic, the topic index now opens that section with a link to the guide page. Each of those guide pages ends with a "See also" box pointing back at its topic section. Fifteen topic sections and twenty-one pages are linked; topics with no real guide coverage are left alone rather than forced.
The backlinks use
sphinx.ext.autosectionlabelwith document prefixes so headings can be cross-referenced by text and a renamed heading fails the build instead of shipping a dead link. Enabling it surfaced 234 duplicate-label warnings, all from pages that repeat a heading within one document (the team page's "Membership", the freelancing guide's "Example"), so those are suppressed. This also makes any heading site-wide referenceable, which nothing could do before.Things a reviewer might want to check:
docs/guide/.🤖 Generated with Claude Code
https://claude.ai/code/session_0192eR5sFokw734d1pJbMbE5
Generated by Claude Code
📚 Documentation preview 📚: https://writethedocs-www--2784.org.readthedocs.build/