Skip to content

docs: star-the-repo asks at the highest-goodwill moments (#2885) - #2886

Merged
vybe merged 1 commit into
devfrom
feature/2885-star-asks
Sep 20, 2026
Merged

vybe merged 1 commit into
devfrom
feature/2885-star-asks

Conversation

@oleksandr-korin

Copy link
Copy Markdown
Contributor

Summary

One reasoned "star the repo" ask on four surfaces — one sentence each, same register as the README's existing one-line callouts (no !, no "please", a real reason on every line: it's how other people find Trinity).

  • README top, under the badge row — catches the warm visitor who arrived from a referral and stars before reading.
  • README Quick Start, right after the Phase A "Access" block — the moment the instance just came up. Paired with "Ran into a rough edge? File an issue — we read them."
  • scripts/deploy/start.sh next-steps card, after step 3 — read by every installer at the moment it worked. One insertion covers local and --hosted (it sits above the path split). Raw URL on its own line: copyable in any terminal, linkified in modern ones. Prints on every start by design.
  • docs/AGENT_INSTALL_GUIDE.md Step 3 card — the README's recommended install path has an installing agent reproduce this card rather than relay start.sh output, so without it the recommended path never shows the ask. (Scope expansion from the 3-surface issue, found during plan review.)

Adjacent fix, same file: the guide's card step 1 and the bullet beneath it still described the pre-#2381 first-run wizard ("admin email + email whitelist"). Both now describe what first-run setup actually asks for (connect Claude; the rest under Settings → Integrations), matching start.sh's already-corrected copy.

Changes

  • README.md — +4 (two callouts)
  • scripts/deploy/start.sh — +6 (two echo lines + rationale comment)
  • docs/AGENT_INSTALL_GUIDE.md — +9/−2 (star lines + stale-wizard copy fix ×2)

Rendered start.sh card (local, ADMIN_PASSWORD set)

  3. Or create an agent straight from the UI: Create Agent → pick a template.

  ⭐ If this was easy, star the repo — it's how other people find Trinity:
     https://github.com/abilityai/trinity

─────────────────────────────────────────────────────────────────────────

Test plan

  • bash -n scripts/deploy/start.sh — clean
  • The four existing start.sh-reading suites (test_2390_start_sh_env_and_project_name, test_2281_firstboot_password, test_2280_hosted_compose_parity, test_1810_1814_version_truth) — 44/44 pass; none pins the card wording, step numbering 1–3 unchanged
  • Register check: no ! / please in any added line
  • Secret / email scan on added lines: clean; only URL added is the public repo
  • Eyeball the two README callouts rendered on GitHub

Deliberately out of scope (per issue): in-app ask on the first-run front desk, star-history embed, animated star GIF.

Fixes #2885

🤖 Generated with Claude Code

https://claude.ai/code/session_01Su6ooK6yNx2eMn4D2tLL6L

Adds one reasoned "star the repo" ask on four surfaces, one sentence each,
same register as the README's existing one-line callouts:

* README top, directly under the badge row — for the warm visitor who arrived
  from a referral and stars before reading.
* README Quick Start, right after the Phase A "Access" block — the moment the
  instance just came up; paired with a "ran into a rough edge? file an issue"
  escape hatch so it does not assume everyone loved it.
* scripts/deploy/start.sh next-steps card, after step 3 — read by every
  installer at the moment it worked; covers local and --hosted since the
  insertion sits above the path split. Raw URL on its own line so it is
  copyable in any terminal and linkified in modern ones. Prints on every
  start by design: one line in a card that already repeats is not a nag.
* docs/AGENT_INSTALL_GUIDE.md Step 3 card — the README's recommended install
  path has an installing agent REPRODUCE this card rather than relay
  start.sh's output, so without it the recommended path never shows the ask.

While in that guide's card: its step 1 and the bullet beneath still described
the pre-#2381 first-run wizard ("admin email + email whitelist"), which no
longer appears on an ADMIN_PASSWORD install. Both now say what first-run setup
actually asks for (connect Claude; the rest under Settings → Integrations),
matching start.sh's already-corrected copy.

No "!", no "please", exactly one ask per surface; the only URL added is the
public repo. 44/44 existing start.sh-reading tests pass; bash -n clean.

Fixes #2885

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Su6ooK6yNx2eMn4D2tLL6L

@vybe vybe 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.

merge-train: batch validated on train/20260920-1811 (#2913)

@vybe
vybe merged commit d063328 into dev Sep 20, 2026
26 checks passed
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