Skip to content

docs: document Contrast Reserve and annotate the Object Details screen#471

Draft
brickbots wants to merge 1 commit into
mainfrom
worktree-contrast-reserve-docs
Draft

docs: document Contrast Reserve and annotate the Object Details screen#471
brickbots wants to merge 1 commit into
mainfrom
worktree-contrast-reserve-docs

Conversation

@brickbots

Copy link
Copy Markdown
Owner

What

Documents the Contrast Reserve feature in the user guide and refreshes the Object Details screenshots.

Docs (user_guide.rst, Object Details section)

  • New Contrast Reserve subsection: what the upper-right number estimates, how it's derived (object brightness/size vs. sky brightness, telescope aperture, eyepiece magnification), the dedicated page reached with SQUARE, an interpretation table using the exact on-screen phrases ("Object is not visible" → "Very easy to see"), prerequisites (active telescope + eyepiece, an SQM reading, known magnitude/size), and a note tying it to the SQM.
  • A forward-link to it from the Push-To prose.
  • New What each part of the screen shows subsection with two annotated layout figures.

Screenshots

  • object_details_01.png / object_details_03.png — updated so the contrast reserve value shows in the upper right (captured on Caldwell 6 in the house amber style).
  • object_details_contrast.png — new: the Contrast Reserve page.
  • object_details_pushto_annotated.png / object_details_notes_annotated.png — new: labelled diagrams of the Push-To and catalog-details views.

Testing

  • sphinx-build -n (nitpicky) builds clean; both new cross-references resolve.

🤖 Generated with Claude Code

Add a Contrast Reserve subsection to the user guide explaining the
upper-right number on the Object Details screen: what it estimates, how
it's derived from sky brightness, telescope aperture, and eyepiece
magnification, an interpretation table, its prerequisites, and the
dedicated page reached with SQUARE.

Update the Object Details screenshots (Push-To and catalog details) so the
contrast reserve value is visible, and add two annotated figures labelling
every region of those two views.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@brickbots brickbots marked this pull request as draft June 15, 2026 17:07
@brickbots

Copy link
Copy Markdown
Owner Author

This is almost ready to go, the Claude generated annotations for the object details page need to be re-done by hand

@brickbots brickbots self-assigned this Jun 15, 2026
@mrosseel

Copy link
Copy Markdown
Collaborator

This is almost ready to go, the Claude generated annotations for the object details page need to be re-done by hand

they seem kinda ok? could get it better by hand for sure. Or with Fable :(

@brickbots

Copy link
Copy Markdown
Owner Author

It did a surprisingly good job, all things considered. I do wonder how much better Fable would be. That would be a cool A/B test! I'll spend a few minutes to make this a little prettier and get this committed 👍

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.

2 participants