Skip to content

docs: split README into a lean tour + full reference, declutter landing page#100

Merged
krimvp merged 1 commit into
mainfrom
claude/simplify-readme-docs-4wjq9d
Jul 9, 2026
Merged

docs: split README into a lean tour + full reference, declutter landing page#100
krimvp merged 1 commit into
mainfrom
claude/simplify-readme-docs-4wjq9d

Conversation

@krimvp

@krimvp krimvp commented Jul 9, 2026

Copy link
Copy Markdown
Owner

The 1,700-line README was a wall of text that buried the quick start. It is
now a ~170-line front door — pitch, quick start, compact how-it-works, a
feature table, install/usage essentials — with every flag, mode, default,
and guarantee moved (condensed and properly sectioned) into the new
docs/reference.md, including the plain-language glossary.

The landing page's oversized cards are trimmed to a few sentences each with
links into the reference for depth, a Reference card joins the docs hub,
and the pipeline stage blurbs in app.js are shortened to match. Styling
fixes: inline styles replaced with utility classes, ~140 lines of dead CSS
from an older page removed, the footer brand no longer forced to
display:block by a stale rule, and the legal row's stray divider dropped.

Inbound links in CONTEXT.md and docs/adding-a-harness.md now point at the
reference; AGENTS.md and CLAUDE.md's docs-sync gates name docs/reference.md
so it can't rot.

Co-Authored-By: Claude Fable 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01DP6RrtoHA3sHSkyqRn5hCe

…ng page

The 1,700-line README was a wall of text that buried the quick start. It is
now a ~170-line front door — pitch, quick start, compact how-it-works, a
feature table, install/usage essentials — with every flag, mode, default,
and guarantee moved (condensed and properly sectioned) into the new
docs/reference.md, including the plain-language glossary.

The landing page's oversized cards are trimmed to a few sentences each with
links into the reference for depth, a Reference card joins the docs hub,
and the pipeline stage blurbs in app.js are shortened to match. Styling
fixes: inline styles replaced with utility classes, ~140 lines of dead CSS
from an older page removed, the footer brand no longer forced to
display:block by a stale rule, and the legal row's stray divider dropped.

Inbound links in CONTEXT.md and docs/adding-a-harness.md now point at the
reference; AGENTS.md and CLAUDE.md's docs-sync gates name docs/reference.md
so it can't rot.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DP6RrtoHA3sHSkyqRn5hCe
@krimvp
krimvp enabled auto-merge July 9, 2026 19:43
@krimvp
krimvp merged commit a1edeef into main Jul 9, 2026
2 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