docs: apply documentation review fixes (§1–§5)#460
Merged
Conversation
Navigation, correctness, and de-duplication pass over the published docs, applying sections 1–5 of the June 2026 documentation review. - Split the flat sidebar into three captioned groups: Using your PiFinder / Building & upgrading / For developers - Fix outright bugs: Markdown link in index, unparsed code-block in dev_guide, stale v1 key names (ENT -> SQUARE+0 for screenshots, ENT-A -> Tools > Console for debug mode), Global Options -> Status, typos - Resolve cross-page contradictions: 2A external power minimum and battery runtime arithmetic in BOM, gerbers link to release branch, DIY v2.5 scope note atop the build guide, Tools section deferring to the Menu Map - Single-source the minimum software version via an rst_epilog substitution - Document the Custom RA/Dec targets feature with fresh screenshots and re-capture stale Objects/Tools menu shots - Standardize on "Quick Menu" (was Radial Menu / marking menu) and tie accelerometer to IMU terminology - De-duplicate: shutdown steps, brightness, SkySafari settings, can't-solve note, FAQ stub; share Camera Prep steps between the build and upgrade guides via include snippets - Fix pre-existing build warnings: inconsistent heading ladder in build_guide, dead _static path Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Applies sections 1–5 of the June 2026 documentation review (navigation, bugs, contradictions, terminology, de-duplication). Built clean with
sphinx-build -n— zero warnings.§1 Navigation
:glob:removed.§2 Bugs
index.rstMarkdown-syntax link replaced with proper:doc:links.dev_guide.rstunparsedcode-block(missing blank line) and stray-space blockquote fixed.keyboard_pi.py), debug mode toggles via Tools › Console then 0 (ui/console.py).software.rstanddev_guide.rst.§3 Contradictions (per the agreed resolution table)
release.rst_epilogsubstitution (|min_software|= 2.2.0) and applied on all five pages.§4 Terminology
§5 De-duplication
.. include::snippets (docs/source/includes/).Also fixes two pre-existing build warnings: the inconsistent heading ladder in
build_guide.rst(10Title level inconsistentCRITICALs) and the dead_staticpath inconf.py.🤖 Generated with Claude Code