docs: polish - version switcher, robots.txt, notebook H1 normalization, llms.txt landing links#721
Merged
Conversation
…n, llms.txt landing links Final polish pass of the RTD docs UX overhaul (after #703 IA restructure, #706 IA guards, #713 search fix): - Navbar version switcher (docs/_static/switcher.json, stable + latest; json_url reads the latest build so entries propagate without config changes). ONE-SELECTOR POLICY: replaces the RTD flyout, which is being disabled in the RTD dashboard - documented in conf.py. check_switcher stays off: the build-time URL probe would fail -W until the json first publishes; the dropdown populates client-side. - docs/robots.txt served at the domain root via html_extra_path: keeps the ~60 thin _modules/ source-view pages out of crawlers, preserves the sitemap line (RTD's autogenerated default allowed everything). - Drop "Tutorial N:" prefixes from 8 notebook H1s (08, 18-22, 24, 27) so page titles and search snippets lead with the topic. Page URLs unchanged; only the H1's own fragment id changes, which resolves to the page top the bare URL already opens; sidebar labels were already short-form overrides. Byte-identity JSON round-trip gate as in #713. - Link the 5 section landing pages from diff_diff/guides/llms.txt. - Card copy refinement deliberately dropped (reviewed twice since #703; reads well). Verified: -W build clean; switcher button renders (expected 404 on the not-yet-published json is the only console entry); robots.txt + titles verified in built HTML; search smoke test passes; 192 guides/IA/drift tests + 172 doc-deps tests pass; 8 edited notebooks nbformat-valid.
Overall assessment: ✅ Looks goodExecutive summary
MethodologyNo findings. No methodology registry or paper contracts are affected. Code QualityNo findings. Configuration and JSON are well-formed. PerformanceNo findings. MaintainabilityNo findings. Tech DebtNo findings. SecurityNo findings or exposed secrets. Documentation/Tests
Static validation passed. The full test suite was not run because |
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
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.
Summary
docs/_static/switcher.json(stable + latest,preferred: stable),version-switcheradded tonavbar_end,version_matchfromREADTHEDOCS_VERSION.json_urlpoints at the latest build so future entries propagate to all published versions without config changes.check_switcherstays off - the build-time URL probe would fail the-Wbuild until the json first publishes; the dropdown populates client-side. ONE-SELECTOR POLICY (deploy coupling): the RTD flyout addon (Settings -> Addons -> Flyout menu) is being disabled in the RTD dashboard so the site has a single version control - decided after review flagged that the flyout (50 active versions) plus the navbar switcher would mean two selectors with different lists; documented inconf.py.docs/robots.txtserved at the domain root viahtml_extra_path: disallows only/en/*/_modules/(~60 thin autogenerated source-view pages), preserving the sitemap line. RTD's autogenerated default allowed everything.diff_diff/guides/llms.txt.Methodology references (required if estimator / math changes)
diff_diff/guides/llms.txtis documentation data; no estimator code touched)Validation
-Wbuild clean; robots.txt + switcher.json + revised titles verified in built HTML; switcher button browser-verified (the only console entry is the expected 404 on the not-yet-published switcher json); search smoke test passes; 192 guides/IA/drift tests + 172 doc-deps tests pass; all 8 edited notebooks validate against the nbformat schema.Security / privacy