Repository navigation
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| # README story: every harness, the overload story and the memory pairing | ||
|
|
||
| - Issue: #215 | ||
| - Branch: docs/readme-story | ||
| - Started: 2026-11-18 | ||
|
|
||
| ## TL;DR | ||
|
|
||
| The README top read like documentation and missed the two main selling points. | ||
| It now opens with "one deck for every harness and every model" and a short | ||
| hook from the maintainer's agentic cognitive overload story, then runs as short | ||
| benefit-led sections: cards that bring decisions to you, harness support with | ||
| a plain "where it is today" table, seeing agents' work, the project board, not | ||
| just for code, built in daily use, the memory pairing with the brain, the video | ||
| under "Why I built it" as a clickable thumbnail, and a shorter name section. | ||
| Everything from "Quick install" down is byte-for-byte unchanged. | ||
|
|
||
| ## Scope | ||
|
|
||
| In scope: README content above "Quick install", and this SPEC. | ||
|
|
||
| Out of scope: install, contributing, rules and licence sections, `AGENTS.md`, | ||
| any app behaviour, Nudges availability, the logo. | ||
|
|
||
| ## Truth checks | ||
|
|
||
| - Harness table matches INSTALL.md and the README install note: Claude Code has | ||
| setup, scaffold and persona verification; Codex and Antigravity get launch | ||
| and inbox delivery; persona wiring for both is #214. | ||
| - ACP is described as groundwork: the merged client (#154) is fixture-only with | ||
| no production route. | ||
| - Brain claims (survives compaction, semantic recall, per-agent silos with | ||
| scoped recall, shared vault, filesystem-first) checked against the public | ||
| brain README and architecture doc. Deck's quick setup does not install it; | ||
| the scaffold can wire a built checkout (#21), so the README says "pairs with". | ||
| - Plugins are described as coming, not available. | ||
|
|
||
| ## Test plan | ||
|
|
||
| - `node scripts/leak-gate.mjs`, `git diff --check`, ASCII-only scan of README | ||
| and this SPEC, and `pnpm -C packages/deck check:dashes`. | ||
| - Diff of everything from "Quick install" down against `origin/main`: empty. | ||
|
|
||
| ## Log | ||
|
|
||
| ### 2026-11-18: README top rewritten as a sales page | ||
| - What changed: the opening sections of README.md now lead with one deck for every harness and model, the cognitive-overload story and video, the brain, the origin as an internal tool and not just for code. | ||
| - Why: the maintainer found the first README dry and missing the harness and memory selling points. | ||
| - Supersedes: the opening and feature sections from #213, additive below "Quick install". | ||
| - Commits: 519b3a3 docs(readme): story pass: harnesses, the brain, origin and video (#215) | ||
|
|
||
| ### 2026-11-18: leak gate limits the brain link and video caption | ||
| - What changed: the README names "the brain" without a link and the video caption carries the title only. | ||
| - Why: the leak gate denies the memory project's repository name and the maintainer's name in file content. Linking needs a maintainer decision on a narrow gate exemption. | ||
| - Supersedes: nothing, additive. | ||
| - Commits: 519b3a3 docs(readme): story pass: harnesses, the brain, origin and video (#215) | ||
|
|
||
| ### 2026-11-18: copy tightened after independent review | ||
| - What changed: duplicate harness lines removed, the licence line merged, the video uses the full-size thumbnail with a watch cue, and the Quick install caveat points at the harness table. | ||
| - Why: review by a different model found the harness list repeated four times and a letterboxed thumbnail. | ||
| - Supersedes: wording from 519b3a3 only. | ||
| - Commits: 248a885 docs(readme): tighten copy, full-size video thumbnail, dedupe harness lines (#215) | ||
|
|
||
| ### 2026-11-19: harness table updated after the wiring port landed | ||
| - What changed: the Codex and Antigravity rows now describe generated persona files, launch, resume and inbox delivery, and the Quick install note points at `create-agent.sh --runtime`. | ||
| - Why: the cross-harness wiring (#214) merged, so the earlier "being ported" wording was no longer true. | ||
| - Supersedes: the harness table rows from 519b3a3. | ||
| - Commits: 3530108 docs(readme): harness table matches the merged wiring (#215) | ||
|
|
||
| ## Follow-ups | ||
|
|
||
| - Add the logo to the header once picked. |
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
Oops, something went wrong.
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.
docs(readme): story pass: harnesses, the brain, origin and video (#215) #216
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Uh oh!
There was an error while loading. Please reload this page.
docs(readme): story pass: harnesses, the brain, origin and video (#215) #216
Changes from all commits
519b3a3248a8856416da8439364b3530108062058eFile filter
Filter by extension
Conversations
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Uh oh!
There was an error while loading. Please reload this page.