Skip to content

docs: modern README refresh for the completed roadmap - #112

Merged
evdatsion merged 1 commit into
mainfrom
claude/docs-modern-refresh
Oct 20, 2026
Merged

evdatsion merged 1 commit into
mainfrom
claude/docs-modern-refresh

Conversation

@evdatsion

Copy link
Copy Markdown
Member

What this does

Refreshes the root README and docs to reflect the completed six-phase build and give the project a modern look.

  • New visuals in docs/: a hero banner (hero.svg), a system-at-a-glance diagram (overview.svg: open-core engine, the moat, and the control plane), and a terminal demo of the daily loop (demo.svg). They are self-contained dark SVG cards, so they read the same on GitHub light and dark.
  • Rewritten README: centered hero, a refreshed badge row, a short "Why Cohort", the how-it-works loop, the demo, the "what's inside" diagram, the six MCP tools and the CLI commands as tables, a collapsible quickstart, and a roadmap that marks all six phases shipped. The stale "cohort-mcp (Phase 1, in progress)" framing is removed.
  • The existing architecture diagram is now client-neutral: it no longer names a single client.
  • CHANGELOG.md records Phases 2 through 6 and this refresh under Unreleased.

Docs-only change. No code, tool, or behavior changes.

Verification

  • All 18 local link and image targets in the README resolve; the four SVGs are well-formed XML.
  • No em or en dashes in the README, CHANGELOG, the SVGs, or the other docs authored recently (project style).
  • The tool and CLI tables match what actually ships; the install instructions stay pinned to the real v0.3.0 release; the control plane is described as separate and optional.
  • Local redaction scan (gitleaks) clean.

Rewrite the root README for the finished six-phase build: a new hero banner, a
system-at-a-glance diagram, and a terminal demo (docs/hero.svg, docs/overview.svg,
docs/demo.svg); the engine's six MCP tools and the CLI commands as tables; a
collapsible quickstart; and a roadmap that marks all six phases shipped. Remove
the stale Phase 1 in-progress framing. Make the architecture diagram
client-neutral (no single client named). Record Phases 2 through 6 and this
refresh in the changelog.

Signed-off-by: evdatsion <31140661+evdatsion@users.noreply.github.com>
@evdatsion evdatsion added the type:docs Documentation label Oct 20, 2026
@evdatsion
evdatsion merged commit b3d3a60 into main Oct 20, 2026
3 checks passed
@evdatsion
evdatsion deleted the claude/docs-modern-refresh branch October 20, 2026 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant