Skip to content

docs(readme): README v2, nothing collapsed, one carrier per fact - #93

Merged
jothimani-rajendran merged 2 commits into
mainfrom
rw7b-readme-v2
Oct 7, 2026
Merged

jothimani-rajendran merged 2 commits into
mainfrom
rw7b-readme-v2

Conversation

@jothimani-rajendran

@jothimani-rajendran jothimani-rajendran commented Oct 7, 2026 •

Copy link
Copy Markdown
Collaborator

What

RW-7b (org-plan plan/readme-v2.md). Every <details> block is removed, and panels whose facts the visible text already carries are dropped. The hero stays. When open-coder-ai/chock#244 merges it becomes the context-report wordmark and mark, without the tagline, at 1760×380 (same file name). Alt text: "context-report wordmark and mark on a dusk-blue background."

Panel Decision Reason
cover-context-report keep (hero) wordmark-only hero after chock#244; the tagline duplicated the H1
appsec drop the section's text table carries the areas, policies and tiers
adopt drop "Two ways to adopt it" carries both routes and their commands
layers drop How it works holds the same layer rows verbatim
honest drop "Guardrails, not guarantees" carries the tiers
family drop "Part of open-coder-ai" table lists all 13 repositories

The repo's own demo GIF and the docs/figures and paper/figures charts are unchanged (they are not shared panels).

Definition of done

$ grep -c "<details" README.md
0
$ grep -n -i -F -e "pip install chock" -e "free forever" -e "never leaves" -e "would have prevented" -e "[stars]" -e "rtk" -e "hallucinat" -e "100%" -e "removes the findings" -e "never sends" README.md | grep -v 'width="100%"'
(empty)
$ pytest -q $(grep -rln README tests --include=*.py)
59 passed, 1 skipped in 9.79s

README: 357 lines, 2,968 words (wc). Ruff, schema and policies are untouched.

Claims

No row or claim changes; README layout only.

🤖 Generated with Claude Code

jothimani-rajendran and others added 2 commits October 7, 2026 01:54
Removes every <details> block, so each heading, table and code block
is visible. Drops the shared panels whose facts the visible text
already carries; the hero cover stays, and becomes visual-only once
the matching chock change merges (same file name).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Jothi Mani Rajendran <250249270+jothimani-rajendran@users.noreply.github.com>
The hero now shows the repo's wordmark beside the mark (chock#244), so
the alt text says so.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Jothi Mani Rajendran <250249270+jothimani-rajendran@users.noreply.github.com>
@jothimani-rajendran
jothimani-rajendran marked this pull request as ready for review October 7, 2026 02:28
@jothimani-rajendran
jothimani-rajendran merged commit 254c2ab into main Oct 7, 2026
15 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.

1 participant