Skip to content

README: slim redesign — half the length, journeys told once#27

Merged
CognitiveCodeAI merged 1 commit into
mainfrom
docs/readme-slim
Jun 11, 2026
Merged

README: slim redesign — half the length, journeys told once#27
CognitiveCodeAI merged 1 commit into
mainfrom
docs/readme-slim

Conversation

@CognitiveCodeAI

Copy link
Copy Markdown
Owner

Maintainer feedback: too wordy, too long, duplicated, harder to follow than it should be. True — eight releases of accretion told the journeys four times.

The redesign (354 → ~200 lines, most of the remainder collapsed):

  • Hero: h1 · banner · two-line value prop · badges (CI first) · mini-nav — the standard beautiful-repo opener
  • Install moved to the top (the Reframe to any-repo + rename skills; harden audit integrity #1 thing a visitor wants), two warnings folded into one callout
  • One journeys table — goal · just-say · commands · you-get — replacing intro bullets + goals table + mermaid + three command tables (the mermaid's full detail lives on in docs/OVERVIEW.md)
  • Guard and GitAlive: one tight section each, led by their visual
  • Family tree + sibling pattern + lazarus-github collapsed into one short section
  • Deep dives and FAQ unchanged in substance, still collapsed; star CTA cut from ~14 lines to 2
  • In-body ToC removed — the hero mini-nav replaces it, and the README is now under the gitalive rubric's own ToC threshold

No facts changed; nothing user-facing removed without a surviving home (OVERVIEW / skill docs).

🤖 Generated with Claude Code

The page had grown by accretion across eight releases: the journeys
were explained four times (intro bullets, goals table, mermaid, three
per-journey command tables). Redesigned to the canonical slim shape:

- centered hero: h1, banner, two-line value prop, badges, mini-nav
- Install first (the #1 visitor intent), warnings folded to one callout
- ONE journeys table (goal · say · commands · you get)
- guard and GitAlive each one tight section with their visual
- family tree + sibling pattern + lazarus-github in one section
- deep dives + FAQ stay collapsed; star CTA cut to two lines
- footer carries overview/contributing/maintaining links

Cut: mermaid (duplicated the table; full version lives in OVERVIEW),
per-journey command tables, in-body ToC (mini-nav replaces it; README
is now under the gitalive rubric's ToC threshold), long star section.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@CognitiveCodeAI CognitiveCodeAI merged commit 6eb745a into main Jun 11, 2026
1 check passed
@CognitiveCodeAI CognitiveCodeAI deleted the docs/readme-slim branch June 11, 2026 00:57
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