Skip to content

Docs: roll selected main doc updates into release#457

Merged
brickbots merged 1 commit into
releasefrom
docs/rollout-to-release
Jun 7, 2026
Merged

Docs: roll selected main doc updates into release#457
brickbots merged 1 commit into
releasefrom
docs/rollout-to-release

Conversation

@brickbots

Copy link
Copy Markdown
Owner

Promotes documentation changes from main to release, limited to docs whose underlying feature is already present on release (or that are pure hardware/voice changes). The selection was reviewed against release's actual code, not just the doc diff.

Migrated

  • New page equipment.rst (+ images, wired into toctree) — telescope/eyepiece guide; the equipment system and flip/flop image orientation are already on release.
  • New page sd_card.rst (+ images, wired into toctree) — SD card swap guide. The images were never committed on main (untracked locally), so they're committed here so the page renders.
  • user_guide.rst — lean-pass voice rewrite, Power & Charging + LiPo safety section, Advanced-submenu setting pointers, flip/flop object-detail image.
  • troubleshooting.rst — symptom-indexed Troubleshooting & FAQ. The EQ-mount answer is version-aware and explicitly covers 2.5.x behaviour.
  • catalogs.rst — WDS paragraph voice polish (catalog data already on release).
  • build_guide / skysafari / software / v25_upgrade — lean-pass voice + Advanced pointers.

Held back (main-only features — intentionally NOT migrated)

  • Focus-quality (HFD) indicator and the refreshed focus strip
  • Resolution-flexible 176px (SSD1333) display support
  • OpenClaw REST API additions (api.rst)
  • Flask/Jinja web UI section (dev_guide.rst)
  • Lynga catalog row
  • pygame keyboard input
  • quick_start.rst (dominated by the main-only focus-strip imagery)

Verification

sphinx-build -n source succeeds — no broken cross-references, no undefined labels, no missing images. Only the pre-existing benign _static path warning remains (already present on release).

🤖 Generated with Claude Code

Promote documentation changes from main to release, including only docs
whose underlying feature is already present on release (or that are pure
hardware/voice changes). Held back: focus-quality (HFD) indicator,
resolution-flexible 176px display, OpenClaw REST API, Flask/Jinja web UI,
Lynga catalog, and pygame keyboard input — all main-only.

Migrated:
- New page: equipment.rst (telescope/eyepiece guide; equipment + flip/flop
  are on release) + images, wired into the toctree
- New page: sd_card.rst (SD card swap guide) + images, wired into the toctree.
  Images were untracked on main; committed here so the guide renders.
- user_guide.rst: lean-pass voice rewrite, Power & Charging + LiPo safety
  section, Advanced-submenu setting pointers, flip/flop object-detail image
- troubleshooting.rst: symptom-indexed Troubleshooting & FAQ (version-aware
  EQ-mount answer covers 2.5.x)
- catalogs.rst: WDS paragraph voice polish
- build_guide / skysafari / software / v25_upgrade: lean-pass voice + Advanced
  pointers

sphinx-build -n is clean (no broken cross-references or missing images;
only the pre-existing _static path warning remains).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@brickbots brickbots merged commit 0c017d7 into release Jun 7, 2026
2 checks 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