Skip to content

Polish README presentation and screenshots - #1

Merged
salemsayed merged 1 commit into
mainfrom
readme-polish
Aug 10, 2026
Merged

Polish README presentation and screenshots#1
salemsayed merged 1 commit into
mainfrom
readme-polish

Conversation

@salemsayed

Copy link
Copy Markdown
Owner

Presentation-only audit of the repo: no code changes.

Screenshots

  • history.png — cropped away the empty bottom ~55% of the image.
  • settings.png — removed the half-cut "Check now" row bleeding in from the card above, trimmed side whitespace.
  • panel.png — dropped the redundant counts header (already visible in history.png) and faded the truncated right edge so the cut-off text reads as intentional rather than broken.
  • reviewer-work.png — same right-edge fade.
  • All four now carry a 1px #d0d7de frame so they don't bleed into GitHub's white background.

README

  • Badges moved up under the tagline (standard placement), added a bb ≥ 0.35 badge.
  • Install and Configure moved up ahead of the deep-dive sections — a visitor can get running before reading the design essay. Deep sections (finding lifecycle, unavailability, reviewer thread) follow.
  • Settings screenshot now lives inline in Configure instead of a collapsed block 100 lines away.
  • New Mermaid state diagram of the finding lifecycle (render-tested; GitHub displays it theme-aware).
  • The panel screenshot's recursion is now a captioned feature: it shows Advisor flagging a stale screenshot in this very README — dogfooding proof, previously just confusing.
  • Security full-trust paragraph converted to a [!IMPORTANT] alert; Node 22 noted under Development.

Every factual claim was checked against the source: settings defaults and ranges, CLI commands, the 24-hour advice retirement, CI steps, engines field — all already accurate, none changed.

🤖 Generated with Claude Code

https://claude.ai/code/session_01RtFj6F6knqncNGAyv7rscC

- Recrop screenshots: drop the empty bottom half of history.png, the
  half-cut card remnant atop settings.png, and the redundant header bar
  in panel.png; fade the right edge where the capture truncates text so
  the cut reads as intentional; frame all four in a 1px border so they
  no longer bleed into GitHub's background.
- Reorder the header: badges up under the tagline, hero below them.
- Move Install and Configure up, ahead of the deep-dive sections, and
  inline the settings screenshot into Configure instead of hiding it in
  a details block at the top.
- Add a Mermaid state diagram of the finding lifecycle.
- Caption the panel screenshot's dogfooding story: the finding shown is
  Advisor flagging a stale screenshot in this same README.
- Convert the full-trust security paragraph to a GitHub alert, add the
  bb version badge, and note the Node 22 requirement.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RtFj6F6knqncNGAyv7rscC
@salemsayed
salemsayed merged commit 9f648b6 into main Aug 10, 2026
1 check passed
@salemsayed
salemsayed deleted the readme-polish branch August 10, 2026 15:35
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