Repository navigation
docs: make the README user-facing with screenshots - #666
Merged
Merged
Conversation
Lead with the product vision, a workbench screenshot, and a short list of what users get; keep every install fact but move developer material (launchers, packaging, e2e commands) into CONTRIBUTING.md. The analytics note mirrors the in-app consent wording. Screenshots ship as dark/light pairs under .github/readme-assets and swap with the reader's GitHub theme; AGENTS.md gains the rule to keep README claims and screenshots current.
Rinat S (rsolmano)
requested review from
Olga Lavrichenko (OLavrik),
Rustam Sadykov (SBOne-Kenobi) and
danyaberezun
as code owners
October 6, 2026 22:09
5 tasks done
Rinat S (rsolmano)
enabled auto-merge
October 6, 2026 22:10
This was referenced Oct 7, 2026
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
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.
Problem
The README opened with a wall of signing/notarization caveats, then spent half its length on contributor material that
CONTRIBUTING.mdalready owned. Someone landing on the GitHub page learned how the repo is laid out before learning what ThinkRail does or seeing it. #514 raised this; this PR takes the same goal from the maintainers' side, with the current product vision and screenshots.Approach
Make the README the user-facing front page and let
CONTRIBUTING.mdown developer material:goal-and-requirements.md(so every claim traces to the product spec). The worktree claim admits the Default workspace rather than promisingmainstays clean.AnalyticsPreferences.tsx) and nothing more; the detailed event catalogue stays in the analytics spec.e2e:binary/e2e:desktop, the source-update caveats) merges intoCONTRIBUTING.mdwithout duplicating what it already had; the stale repo-layout block is replaced by a pointer toarchitecture.md, which owns the complete list.<picture>so they match the reader's GitHub theme.AGENTS.mdgains one Handoff-hygiene bullet so README claims and screenshots are reviewed when a user-visible capability, install, or analytics behavior changes.Every decision was reviewed in three rounds by a second model (gpt-6-astra); its blocking findings (over-claiming "no personal data", Intel "build from source" in the wrong table column) are applied.
Changes
README.mdrewritten;.github/readme-assets/{workbench,specs}-{dark,light}.pngadded (150–190 KB each, no metadata).CONTRIBUTING.md: launchers, packaging/smoke,e2e:binary/e2e:desktop, unstamped-build updater caveat, smoke≠notarization note, repository-layout pointer.AGENTS.md: README-currency rule under Handoff hygiene.Screenshots
Not applicable — no frontend changes. The README itself embeds the new screenshots; view this branch's README on GitHub in light and dark mode to see both pairs.
Related issues
Supersedes #514.
Checklist
bun run lint,bun run typecheck,bun run test— lint and typecheck ran in the pre-commit hook on the final tree (green);bun run testnot run: documentation-only change, no code touchedbun run e2e, orbun run e2e:fullwhen touching agent behavior) — not applicable, documentation onlySPEC.md/ top-level specs updated to reflect any boundary, contract, or behavior change — none changed; AGENTS.md updated for the new README rule