docs: refresh root README to v1.6 feature set - #15
Merged
Conversation
The root README was stale at v1-era feature descriptions everywhere except the "Cloud transport" section (added by the v1.6 merge) -- "How it works" still listed a flat 3-tier priority scheme (including a "priority 10 built-in apps" claim with no backing constant in src/busybar/display.py) with no mention of the v1.5.2 escalation tiers or overlay/dwell mechanics, and the "What's inside" table's two one-line descriptions predated the entire v1.5-v1.5.2 feature line. "How it works" now carries the full six-tier priority ladder (ambient 20 / overlay 21 / raised 25 / alert 60 / urgent 65 / session 90, one line each on what occupies the tier, cross-checked against src/busybar/display.py's actual constants), plus explicit paragraphs on the two firmware facts (equal priority is rejected not handed off; eviction is not restoration), overlay dwell/rotation mechanics, escalation-beats-alerts behavior, and snooze-by-acknowledgment -- kept the existing element-timeout self-clearing note and application_name ownership-tagging note. "Cloud transport"'s "Post-merge live-probe checklist" (three open action items) is replaced with the now-measured results: base URL api.busy.app/busybar confirmed correct, 5/5 forced-cloud draws DRAWN at 300-465ms (median 353ms, ample headroom under the 10s ambient cadence), and auto-fallback confirmed live in production with logged transitions. The "What's inside" table's two descriptions are rewritten to the actual shipped v1.6 feature set: calendar_countdown's four-stage escalation (approach/notice/warn/imminent-LED, with real default minute values), one chirp at event start, teal in-progress state, and optional auto_busy; ci_status's account-wide auto-discovery, running badge with ETA + remain/left label, GitHub GraphQL/REST quota gauges, red/amber alert badges, and start-button snooze. Every claim was cross-checked against source (src/busybar/display.py, src/busybar/config.py's DEFAULTS, both per-integration READMEs, both main.py argparse definitions, pyproject.toml's Python requirement) -- no feature drift introduced in either direction. Quick-start commands, config-reference pointers to per-integration READMEs, and section order (purpose -> requirements -> quick start -> how it works -> adding an integration -> configuration -> cloud transport -> index) were sanity- checked and left unchanged; no personal data introduced. README.md only -- full test suite untouched and verified green (346 passed) before and after. Report at .superpowers/sdd/readme-v1.6-refresh-report.md (gitignored). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refreshes the root README from its v1-era feature descriptions to the shipped v1.6 state. Docs-only (README.md, 76 lines changed); no source or test changes — suite untouched at 346 passing.
Every claim cross-checked against
display.pyconstants, config DEFAULTS, argparse flags, and per-integration READMEs. Hygiene sweep on the diff: no personal data.🤖 Generated with Claude Code