Repository navigation
docs: make the README a user-facing page - #514
Iaroslav (Rick) Postovalov (CommanderTvis) wants to merge 1 commit into
Conversation
ce04101 to
c407e0a
Compare
|
Maciej Gorywoda (@makingthematrix) the thinkrail.ai link in README.md can also have tracking URL, but the source needs to be different than "blog". |
8a39293 to
c579f3c
Compare
376aaa8 to
aced023
Compare
aced023 to
4c6c03f
Compare
fa4dceb to
46faea5
Compare
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
46faea5 to
cf13de7
Compare
|
Thanks Iaroslav (Rick) Postovalov (@CommanderTvis) — superseded by #653, which keeps your commit (and authorship) rebased onto main, reconciled with the #643 positioning, plus a follow-up polish commit. On the website link: #653 uses |
|
Thanks for this, Iaroslav (Rick) Postovalov (@CommanderTvis) — you were right that the README buried what ThinkRail is under signing caveats and contributor material, and the fork's screenshot-led page was a big part of the inspiration. We took the same goal from our side in #666: it leads with the current product vision and real workbench screenshots (dark/light pairs that follow the reader's GitHub theme), derives the feature highlights from Closing this one in favor of #666. It would be great if you could take a look there and tell us whether it does what you were asking for — anything you think is still missing is welcome as a comment on that PR. |
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.Approach
Split the two audiences the README was serving. The README now leads with the pitch and the install command, keeping only the platform facts a downloader acts on (prebuilt platforms, signing status, Linux desktop deps, version pinning).
Everything a contributor needs moved into CONTRIBUTING.md.
Changes
Screenshots
Related issues
Checklist
bun run lint,bun run typecheck,bun run test— docs-only change, no code touchedSPEC.md/ top-level specs updated to reflect any boundary, contract, or behavior change — not applicable, no boundary/contract/behavior change🤖 Generated with Claude Code