docs: reorganize both READMEs around a Quick Start, add ecosystem diagram - #55
Merged
Conversation
…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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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):
/cys:flow→ done/run-plan, Handoff phase, branch topologyCONTRIBUTING.md)Real finding surfaced along the way: verified via
commands/flow.md'sCLAUDE_PLUGIN_ROOTresolution andmarketplace.json'ssource: "./"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 buildneeded 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.mmddirectly as a rendered Mermaid diagram (GitHub renders it natively) in both READMEs instead of only linking the file, and fixedexamples/README.md's now-stale#usageanchor (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
docsrule)Test plan
npm test— 153/153 pass (no test references README content directly)#anchorlinks resolve against actual heading slugs in both files (script-checked, zero mismatches)#usage,#installation,#requirements) — found and fixed one live reference inexamples/README.mdhttps://claude.ai/code/session_0145sjAtP5b5kvhR1XCgg3K3