docs(readme): keep user-facing sections in plain, human language#130
Open
bepcyc wants to merge 1 commit into
Open
docs(readme): keep user-facing sections in plain, human language#130bepcyc wants to merge 1 commit into
bepcyc wants to merge 1 commit into
Conversation
The README leaked implementation detail — issue numbers, spec IDs, internal component names, and CI/release plumbing — into user-facing sections, so it read "built by megageeks for megageeks" to the actual target reader: a cyclist, not an engineer. Move that detail out of the reader's way while keeping it findable. - Roadmap: rewrite the dev-changelog bullets as one plain user-outcome line per release. Keep the Banister / Coggan / Seiler codenames and the sports-science framing (the domain richness the target reader actually wants), drop every issue number and spec ID, and add a single milestone link so the work stays findable without being pushed at the reader. - intervals.icu note: translate down to the load-bearing fact — auto sync isn't available in this build, upload files instead — and drop the 422 / "credential probe" / endpoint / connector internals. - Released image: keep the user-relevant constraint (x86/Intel only; won't run on ARM / Apple Silicon / Pi) and drop the "pinned snapshot / may trail these docs" release-engineering note. - How it works: trim the storage line to plain words (no "connection string" / "that one setting"). - Quick start: "no extra migration step" -> "no extra setup step". - Leave ## For developers unchanged — the correct home for the stack, test tiers, and OpenAPI surface. Honest caveats are translated into the user's vocabulary, not deleted, in keeping with the project's honesty-first promise. Closes #114 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018NhEyetbQCmnw8obPg7Awp
bepcyc
force-pushed
the
claude/zealous-lovelace-2szabr
branch
from
June 30, 2026 14:02
f902281 to
15e03a1
Compare
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.
Closes #114.
Why
The README leaked the implementation layer — issue numbers, spec IDs (
VOICE-R2), internal component names (grounder,work_above_cp_j,interrupt_id, "credential probe"), and CI/release plumbing — into user-facing sections. To the actual target reader (a cyclist, not an engineer) that reads "built by megageeks for megageeks." This moves that detail out of the reader's way while keeping it findable (milestones, dev docs, source).## For developersis untouched — it's the correct home for the tech.The guiding lens (see my review on the issue): cut vs. translate. Pure author-POV plumbing gets cut; a true, load-bearing caveat gets translated into the user's vocabulary, not deleted — because for an honesty-first project, user-friendly never means hiding an inconvenient truth.
Changes (maps to the issue's proposed list)
#NN/spec IDs dropped; one milestone link added so the work stays findable.422, "credential probe",GET /v1/connections/available, "connector", "stock OSS container".Plus a small adjacent cut: Quick start's "no extra migration step" → "no extra setup step".
The roadmap shift (the most visible change)
Before — a user meets issue numbers and internals:
After — same release, framed as what the reader gets (codename/science kept):
Acceptance check
A cyclist can now read the whole README and never meet an issue number, a spec ID, an internal component name, or a CI/release detail outside
## For developers. The detail stays findable (milestone link, dev docs, source) but is no longer pushed at the reader. Net diff is −19 lines.Deliberately out of scope (follow-ups, not this PR)
curl+ token minting, so the medium (not just the words) caps how friendly Quick start can feel. Likely a separate "user-friendly path in" issue.🤖 Generated with Claude Code
https://claude.ai/code/session_018NhEyetbQCmnw8obPg7Awp
Generated by Claude Code