Skip to content

Docs backlog: focus, alignment reticle, catalogs, SkySafari, updates + FAQ consolidation#439

Merged
brickbots merged 7 commits into
mainfrom
docs/backlog
May 25, 2026
Merged

Docs backlog: focus, alignment reticle, catalogs, SkySafari, updates + FAQ consolidation#439
brickbots merged 7 commits into
mainfrom
docs/backlog

Conversation

@brickbots
Copy link
Copy Markdown
Owner

Works through several items from the documentation enhancement backlog, plus two supporting tooling improvements.

Documentation

  • Quick Start focus (Prep for 1.1.0 release #2) — lead the Setting Focus section with "focus is the #1 reason solving fails", stress zooming to 2x/4x, give a ~6mm-of-thread starting point, and add high-thin cloud + AUTO-exposure (2.2.x caveat) to the troubleshooting note.
  • Alignment reticle (#3) — add a note that the Telrad reticle is expected to sit off-center within the 10° FOV, and re-capture all four alignment demo images on a consistent star field so the reticle is clearly off-center and the flow reads coherently.
  • Catalogs (ENT+A turns screen off #6) — add the missing TLK (variable stars) and Lyn (Lyngå open clusters) catalogs, correct the WDS pair count to 130,000+ to match the shipped DB, and document finding large catalogs via Name Search / Nearest sorting.
  • SkySafari (#5) — add Using SkySafari (what it does/doesn't do today, single-connection limit, sleep stops updates) and Troubleshooting (PiFinderAP auto-disconnect, .local→IP, no position until first solve, same-SSID interference).
  • Software updates (#8) — reassure that updates happen on-device (no mail-in; units often ship a version behind), explain the "unknown" version state, and note the "not a multiple of 512 bytes" bad-download error on the software setup page.
  • FAQ consolidation — move the user guide's separate FAQ (EQ mount, motorized-mount control, GPS/chrony clock) onto the Troubleshooting & FAQ page and replace the user-guide section with a pointer, so there is a single FAQ.

Tooling (docs skill)

  • Voice guidance — make the house-voice guidance more formal and add a rule never to open a sentence with a conjunction.
  • screenshot_to_doc.py — add a --gamma mid-tone lift (default 1.5) so dim elements like the title bar stay legible after the amber recolor.

Verification

Nitpicky Sphinx build (sphinx-build -n) is clean aside from the pre-existing _static/api.rst warnings; all cross-references resolve. The four new alignment images were captured with the pifinder-remote skill and converted with the updated screenshot_to_doc.py.

🤖 Generated with Claude Code

brickbots and others added 7 commits May 24, 2026 15:52
Quick Start (item #2): focus is the most common reason solving fails, so
lead the Setting Focus section with that, stress zooming to 2x/4x to judge
star tightness, give a ~6mm-of-thread starting position, and add high-thin
cloud plus the AUTO-exposure (2.2.x caveat) to the troubleshooting note.
Cross-link to the new Troubleshooting page.

Catalogs (item #6): add the missing TLK (variable stars) and Lyn (Lyngå
open clusters) catalogs, correct the WDS pair count to 130,000+ to match
the shipped database, and document finding large catalogs by Name Search
or Nearest sorting.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Shift the house-voice guidance from "encouraging and a little excited"
toward warm but measured, reserve exclamation points, and add a rule to
never open a sentence with a conjunction (And/But/So). Bring the skill's
own prose into line with that rule.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add a note to the Alignment section stating the Telrad-style reticle marks
where the scope points within the camera's 10° field of view and will not be
centered, which is normal. Re-capture all four alignment demo images on a
single consistent star field so the reticle is clearly off-center and the
flow reads coherently.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Dim elements like the title bar text were hard to read after the linear
amber recolor. Add a --gamma step (default 1.5, >1 brightens) applied to the
intensity before recoloring so screenshots stay legible at doc size.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Add a "Using SkySafari" section (follow scope on chart, send targets; the
single-connection limit; no GoTo slew or simultaneous GoTo-mount yet; sleep
mode stops updates) and a "Troubleshooting" section (PiFinderAP
auto-disconnect, .local -> numeric IP, no position until first solve,
same-SSID interference) to the otherwise setup-only page.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
In the Update Software section, reassure that updates happen on-device (no
mail-in; units often ship a version or two behind) and explain that an
"unknown" version means no internet rather than a reason to re-image. In the
software setup page, note that a "not a multiple of 512 bytes" write error
means a corrupted/partial download.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The user guide carried a separate FAQ (EQ mount, motorized-mount control,
GPS/chrony system clock) duplicating the role of the new Troubleshooting &
FAQ page. Move those three questions onto troubleshooting.rst in its
bold-question style (code blocks preserved) and replace the user-guide FAQ
section with a pointer so there is a single FAQ.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@brickbots brickbots merged commit 8130e47 into main May 25, 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