Repository navigation
docs: star-the-repo asks at the highest-goodwill moments (#2885) - #2886
Merged
Merged
Conversation
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
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.
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).scripts/deploy/start.shnext-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.mdStep 3 card — the README's recommended install path has an installing agent reproduce this card rather than relaystart.shoutput, 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 (twoecholines + rationale comment)docs/AGENT_INSTALL_GUIDE.md— +9/−2 (star lines + stale-wizard copy fix ×2)Rendered
start.shcard (local,ADMIN_PASSWORDset)Test plan
bash -n scripts/deploy/start.sh— cleanstart.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!/pleasein any added lineDeliberately 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