Skip to content

docs: reorganize both READMEs around a Quick Start, add ecosystem diagram - #55

Merged
bacsystem merged 2 commits into
developfrom
docs/readme-reorganization
Jul 19, 2026
Merged

docs: reorganize both READMEs around a Quick Start, add ecosystem diagram#55
bacsystem merged 2 commits into
developfrom
docs/readme-reorganization

Conversation

@bacsystem

Copy link
Copy Markdown
Owner

Summary

Both READMEs had grown as an organic history of incremental additions (Cursor section, Gemini CLI section, demo section, bug-reporting section, all appended over the session) rather than a clear path for a new user finding this repo cold. Requested reorganization: proper table of contents, a real Quick Start, and clearer separation between "using cys" (most users) and "building from source" (contributors/advanced).

New structure (both languages, kept in exact parallel):

  1. What is cys? (plugin + engine, skill table, embedded Mermaid ecosystem diagram)
  2. See it in action (60 seconds) — unchanged, kept as the hook
  3. Quick Start (new) — plugin install → /cys:flow → done
  4. Installing the cys plugin (Claude Code / Cursor / Gemini CLI, detailed)
  5. One-time permissions setup (merges)
  6. Using cys — step-by-step guide, manual invocation reference, /run-plan, Handoff phase, branch topology
  7. Building from source (for contributors / advanced engine use)
  8. How it works
  9. Safety checks & known limitations
  10. Reporting bugs & contributing (now links CONTRIBUTING.md)

Real finding surfaced along the way: verified via commands/flow.md's CLAUDE_PLUGIN_ROOT resolution and marketplace.json's source: "./" that installing the cys plugin via the marketplace already materializes a ready-to-run, pre-built copy of this repo — no manual clone/npm run build needed for a typical first run. The old README put the clone-and-build section ahead of any usage content, reading as a requirement it isn't. This reorg makes that explicit and moves "Building from source" to a clearly-labeled contributor/advanced section.

Also embedded docs/diagram/flujo-cys-ecosystem.mmd directly as a rendered Mermaid diagram (GitHub renders it natively) in both READMEs instead of only linking the file, and fixed examples/README.md's now-stale #usage anchor (renamed to #using-cys).

No content was dropped — every existing caveat, permissions note, and known limitation survived the reorg verbatim, just regrouped. Verified all TOC and in-body cross-reference anchor links resolve to real headings (28-29 links checked per file, zero mismatches).

Version

0.6.18 → 0.6.19 (patch, pre-1.0 docs rule)

Test plan

  • npm test — 153/153 pass (no test references README content directly)
  • Verified all TOC + in-body #anchor links resolve against actual heading slugs in both files (script-checked, zero mismatches)
  • Grepped the repo for other files referencing old README anchors (#usage, #installation, #requirements) — found and fixed one live reference in examples/README.md

https://claude.ai/code/session_0145sjAtP5b5kvhR1XCgg3K3

bacsystem and others added 2 commits July 19, 2026 15:39
…gram

Both README.md and README.es.md were structured as an organic history of
incremental additions (Cursor section, Gemini CLI section, demo section,
bug-reporting section, all appended over the session) rather than a
clear path for a new user. Reorganized around: What is cys -> demo ->
Quick Start -> plugin install (per platform) -> permissions setup ->
Using cys (guide, manual reference, /run-plan, handoff, branch
topology) -> Building from source -> How it works -> safety/limitations
-> reporting bugs & contributing. Added a table of contents to both.

Also surfaces a real distinction the old structure buried: installing
the cys plugin via the marketplace already materializes a ready-to-run,
pre-built copy of this repo (confirmed via commands/flow.md's
CLAUDE_PLUGIN_ROOT resolution and marketplace.json's source: "./") — the
"clone + npm install + npm run build" path is only needed for
contributors or advanced engine use, not for a typical user's first run.
The old README put that clone-and-build section ahead of any usage
content, which reads as a requirement it isn't.

Embedded the existing docs/diagram/flujo-cys-ecosystem.mmd content
directly as a ```mermaid fence (GitHub renders it natively) instead of
just linking the file, in both languages.

Fixed examples/README.md's now-stale #usage anchor link (renamed to
#using-cys in this reorganization).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145sjAtP5b5kvhR1XCgg3K3
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0145sjAtP5b5kvhR1XCgg3K3
@bacsystem
bacsystem merged commit 4e3d849 into develop Jul 19, 2026
1 check failed
@bacsystem
bacsystem deleted the docs/readme-reorganization branch July 22, 2026 05:01
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