Skip to content

docs: make the README a user-facing page - #514

Closed
Iaroslav (Rick) Postovalov (CommanderTvis) wants to merge 1 commit into
JetBrains:mainfrom
CommanderTvis:readme
Closed

Iaroslav (Rick) Postovalov (CommanderTvis) wants to merge 1 commit into
JetBrains:mainfrom
CommanderTvis:readme

Conversation

@CommanderTvis

@CommanderTvis Iaroslav (Rick) Postovalov (CommanderTvis) commented Sep 17, 2026 •

Copy link
Copy Markdown
Contributor

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

  • README: pitch and install command lead; desktop app and CLI get their own peer sections under Install, desktop first; JetBrains AI named as the in-app sign-in path alongside bring-your-own provider credentials; Analytics & Privacy compacted to what a user decides on, not a full event-field accounting. 222 → ~80 lines.
  • CONTRIBUTING.md: gained the launcher commands, an "Artifact signing" section, "Architecture", and the repo layout tree; Bun version corrected.

Screenshots

Related issues

Checklist

  • Fast gates pass: bun run lint, bun run typecheck, bun run test — docs-only change, no code touched
  • E2E suite passes for app-affecting changes — not applicable, no app behavior changed
  • Before/after screenshots are included for frontend changes, or marked not applicable
  • Relevant SPEC.md / top-level specs updated to reflect any boundary, contract, or behavior change — not applicable, no boundary/contract/behavior change
  • I have read the Contributing guide and agree to the Code of Conduct

🤖 Generated with Claude Code

@CommanderTvis

Iaroslav (Rick) Postovalov (CommanderTvis) commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor Author

Maciej Gorywoda (@makingthematrix) the thinkrail.ai link in README.md can also have tracking URL, but the source needs to be different than "blog".

@CommanderTvis Iaroslav (Rick) Postovalov (CommanderTvis) changed the title docs: make the README a download page docs: make the README a user-facing page Oct 4, 2026

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes — please address the blocking inline finding.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes — please address the blocking inline finding.

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
@rsolmano

Copy link
Copy Markdown
Collaborator

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 https://thinkrail.ai/?utm_source=github&utm_medium=readme so README traffic is no longer counted under the blog's utm_source=blog.

@rsolmano

Copy link
Copy Markdown
Collaborator

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 goal-and-requirements.md, keeps every install fact, and moves the developer material into CONTRIBUTING.md as you proposed. It also adds a rule in AGENTS.md so the README stays current as capabilities land.

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.

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.

2 participants