Skip to content

Redesign README: hero visual, positive headline, story-first structure - #7

Merged
ali-abassi merged 1 commit into
mainfrom
design/readme-hero
Aug 23, 2026
Merged

Redesign README: hero visual, positive headline, story-first structure#7
ali-abassi merged 1 commit into
mainfrom
design/readme-hero

Conversation

@ali-abassi

Copy link
Copy Markdown
Owner

Headline was failure-first engineer-speak ('Make agent workflows fail visibly, recover safely, and leave proof'). New above-the-fold:

Give your AI agents a checklist they can't skip

  • Centered hero with badges + nav links + assets/hero.svg (pipeline: checklist → runner → step → gate → proof, with the fail → retry → stop → piw resume path). SVG rendered to pixels and visually verified before commit.
  • Mermaid 'how it works' diagram (renders natively on GitHub).
  • Story order: why → 2-minute quickstart with real receipts → how it works → command table → Claude Code/Codex/Pi compatibility with the live any-agent receipt → when to use / when not → internals → evidence → boundary.
  • Nothing weakened: security/trust language, alpha status, permission warning, comparison table, and all doc links preserved. Anchor slugs machine-checked.

Docs + one SVG asset; no code changes.

- New headline: 'Give your AI agents a checklist they can't skip'
  (was failure-first: 'Make agent workflows fail visibly...').
- assets/hero.svg: pipeline visual (checklist -> runner -> step ->
  gate -> proof, with fail/retry/resume path), GitHub-dark styled,
  render-verified.
- Story order: why -> 2-min quickstart with real receipts -> mermaid
  'how it works' -> command table -> agent compatibility -> when to
  use -> internals -> evidence -> boundary.
- All trust/safety language, comparison table, and doc links kept.
@ali-abassi
ali-abassi merged commit 326a9c1 into main Aug 23, 2026
8 checks passed
@ali-abassi
ali-abassi deleted the design/readme-hero branch August 23, 2026 21:52
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