Skip to content

docs: apply documentation review fixes (§1–§5)#460

Merged
brickbots merged 1 commit into
mainfrom
docs/review-fixes
Jun 10, 2026
Merged

docs: apply documentation review fixes (§1–§5)#460
brickbots merged 1 commit into
mainfrom
docs/review-fixes

Conversation

@brickbots

Copy link
Copy Markdown
Owner

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

  • Sidebar split into three captioned groups: Using your PiFinder / Building & upgrading / For developers; unused :glob: removed.

§2 Bugs

  • index.rst Markdown-syntax link replaced with proper :doc: links.
  • dev_guide.rst unparsed code-block (missing blank line) and stray-space blockquote fixed.
  • Stale v1 key names corrected against the code: screenshots are hold SQUARE + 0 (keyboard_pi.py), debug mode toggles via Tools › Console then 0 (ui/console.py).
  • "Global Options" → Status screen; typo fixes in software.rst and dev_guide.rst.

§3 Contradictions (per the agreed resolution table)

  • BOM: external power 2A minimum (1.5A noted as startup peak), runtime arithmetic aligned with the user guide, gerbers link → release.
  • Minimum software version single-sourced as an rst_epilog substitution (|min_software| = 2.2.0) and applied on all five pages.
  • Build guide scope note: DIY v2.5 build in Left/Right/Flat; v3 sold assembled.
  • Custom RA/Dec targets documented (new user-guide section with fresh screenshots; flow verified against the running app), Objects menu updated to five options, stale Objects/Tools menu screenshots re-captured.
  • User guide Tools section now defers to the Menu Map instead of enumerating a stale list.

§4 Terminology

  • Quick Menu everywhere (was "Radial Menu" ×4 and one "marking menu"); one-time "(the radial menu)" bridge kept at first Quick Start mention.
  • Accelerometer ↔ IMU vocabularies tied with a single parenthetical in How It Works.

§5 De-duplication

  • Shutdown steps: full procedure lives in the user guide; Quick Start reduced to the gesture + link.
  • Standalone user-guide Brightness section deleted; one sentence folded into Battery life.
  • SkySafari connection parameters live only on the SkySafari page.
  • Camera Prep / cable-connect steps shared between build and upgrade guides via .. include:: snippets (docs/source/includes/).
  • Quick Start "can't solve?" note trimmed to the two likely causes + troubleshooting link; user-guide FAQ stub removed.
  • Menu-basics lists in Quick Start/User Guide flagged as a linked pair with RST comments.

Also fixes two pre-existing build warnings: the inconsistent heading ladder in build_guide.rst (10 Title level inconsistent CRITICALs) and the dead _static path in conf.py.

🤖 Generated with Claude Code

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>
@brickbots brickbots merged commit 76bc0d9 into main Jun 10, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant