Repository navigation
docs: make the README a user-facing page - #653
Closed
Rinat S (rsolmano) wants to merge 2 commits into
Closed
Rinat S (rsolmano) wants to merge 2 commits into
Rinat S (rsolmano) wants to merge 2 commits into
Conversation
The README opened with a quarter-page of signing, notarization, and packaging caveats before the first install command, then spent half its length on contributor material that CONTRIBUTING.md already owned. Lead with what the app does and the install command; keep only the platform facts a downloader acts on. Move the launcher commands, artifact-signing pipeline detail, three rings, and repo layout into CONTRIBUTING.md, and correct its Bun prerequisite to the pinned 1.4.0. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012hwFzC3P777NWAVLhGFHJu
Rinat S (rsolmano)
requested review from
Olga Lavrichenko (OLavrik),
Rustam Sadykov (SBOne-Kenobi) and
danyaberezun
as code owners
October 6, 2026 07:24
5 tasks done
Contributor
|
I am a bit confused about why this is closed. |
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 quarter-page of signing, notarization, and packaging caveats before the first
install command, then spent half its length on contributor material. A new visitor had to read past all of
that to find
curl ... | bash.This supersedes #514 by Iaroslav (Rick) Postovalov (@CommanderTvis). His commit keeps its authorship and message; rebasing it onto
mainresolved the intro conflict with #643. A separate follow-up commit polishes the result andaddresses the review findings.
Approach
Split the two audiences. The README leads with the pitch and the install commands, keeping only what a
downloader acts on: requirements, per-platform install steps, installer options, platform/signing support,
and the privacy choices. Contributor material moves to CONTRIBUTING.md.
Notable decisions:
?utm_source=github&utm_medium=readmerather than docs: make the README a user-facing page #514'sjb.gg/osk2n7, whichresolves to
utm_source=blogand would count README visits as blog traffic.bash -s --form andX.Y.Zplaceholdersinstead of concrete versions that go stale. The website's install section links to
#installfor"advanced CLI options" and "native library requirements", and the intro blog post links there for the
CLI's install, channel, and update options.
by an installation ID; optional sharing is on by default and starts when the first-launch dialog opens;
--no-analyticsis per-run; the one-time blog open and its marketing-cookie condition.architecture.mdinstead of copying a repo tree that hadalready drifted from the packages on disk.
Changes
Contributing → License. 250 → 139 lines.
Applications link; Windows ZIP whose setup executable (
ThinkRail-Setup.exe/-canary.exe) needs itsadjacent
.installerpayload; Linux tarball with./installer.stapler validate/spctlas Notarized DeveloperID; the macOS CLI is Developer ID signed.
local packages are unsigned), a short "Architecture (three rings)",
e2e:binary/e2e:desktop, and thenote that
thinkrail updatefrom a checkout installs a published binary.Verification for this docs-only change:
bun run lint→ clean;git diff --check origin/main..HEAD→ clean;every relative link and the
architecture.md#topology--three-ringsanchor resolve.Screenshots
Not applicable — no frontend changes.
Related issues
Supersedes #514.
Checklist
bun run lint,bun run typecheck,bun run test— onlybun run lintran (clean); typecheck and unit tests were not run because no code changedbun run e2e, orbun run e2e:fullwhen touching agent behavior) — not applicable, no app behavior changedSPEC.md/ top-level specs updated to reflect any boundary, contract, or behavior change — not applicable, no boundary/contract/behavior change