docs(README): sharpen positioning, add architecture diagram, concrete quickstart#123
docs(README): sharpen positioning, add architecture diagram, concrete quickstart#123esteinberg wants to merge 3 commits into
Conversation
…nd example Improve time-to-understanding without changing the underlying content: - Reframe positioning on "context engineering + governed instructions" consistently (hero, intro), retiring the ambiguous "compiled"/"governance and context layer" phrasings - Add "Without Rosetta / With Rosetta" table and a concrete "Add rate limiting" side-by-side example near the top - Add a "How it works" Mermaid diagram (horizontal, color-coded by ownership: shipped-with-Rosetta / yours / third-party) showing inputs -> Rosetta Runtime -> Agent Adapters -> Guided Execution -> agents - Make Quick Start concrete: real install options table (Plugins / Hosted MCP / Self-hosted MCP), the actual conversational init prompt and the workspace files it generates; drop fabricated CLI guidance - Add "Why not just use IDE rules?" objection handler - Reorder so Quick Start precedes How it works; "Why use it" precedes "For organizations" (developer-first, then enterprise) - Fix "manual validation by AI" -> "independent AI validation backed by execution evidence"; soften over-absolute claims; make daily-work bullets consistent and outcome-led; elevate llms-full.txt Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Follow-up work (if this PR is accepted)This PR was deliberately scoped to 1. Verify the Mermaid diagram renders
2. Propagate the canonical positioning line everywhereThe README hero now stays outcome-driven, but the canonical category line — "Meta-prompting, context engineering, and centralized instruction management for AI coding agents" — should be made consistent across the other surfaces, which currently differ:
3. Sync duplicated phase wording
4. Consider a dedicated comparison pageWe deliberately kept the README lean and used only a short "Why not just use IDE rules?" section. A fuller comparison vs 🤖 Generated with Claude Code |
Rosetta Triage ReviewSummary: This PR is a focused editorial pass on Findings:
Suggestions:
Automated triage by Rosetta agent |
isolomatov-gd
left a comment
There was a problem hiding this comment.
We need more work on this one, we added more text, I'd like to think how we can either reduce it or move it.
I like idea and changes to subheader a lot.
Some things needs to be reverted: **Teach agents how to think, not what to do.** section lost its value and just a duplicate of the subheader.
I am not sure about having init workflow inside of the readme, but I really like the diagram. Maybe we should show like that our quickstart process and we can use similar to show few workflows.
Address review feedback on length and duplication: - Revert hero tagline to "Teach agents how to think, not what to do" (the "Encode your engineering discipline" variant duplicated the subheader) - Remove the redundant "daily work" bullets and collapse the 5-line phases list into a single line — the Without/With + Example tables and the How-it-works diagram already convey this - Replace the verbose Quick Start init instructions with a compact process diagram (ask → analyze → workspace files → build); full steps stay in QUICKSTART.md Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Update: trimmed length + init-as-diagramPushed a follow-up commit addressing length/duplication feedback:
Added to follow-up backlog
|
…lumns Merge the separate "Why use it" and "For organizations" lists into one two-column table (For builders | For organizations). Re-buckets bullets by audience, dedupes the guardrails/governance overlap, and reclaims the plain-language-tasks and less-babysitting points cut from the intro. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
What
A focused editorial pass on
README.mdto improve time-to-understanding for first-time GitHub visitors. No code or behavior changes — content only.Positioning & vocabulary
compiled/ "governance and context layer" phrasings.New fast-comprehension pieces
Quick Start made real
TECHSTACK.md,CODEMAP.md,DEPENDENCIES.md,ARCHITECTURE.md,CONTEXT.md).pip install rosetta-cli/rosetta initguidance (verifiedrosetta-cliis a RAGFlow publishing/admin tool, not the entry point).llms-full.txtas a machine-readable entry point.Structure & tone
manual validation by AI→independent AI validation backed by execution evidence.Why
The README's content was strong but front-loaded with explanation; this trades some prose for visuals, a concrete example, and a faster trial path.
Reviewer notes
docs/web/docs/introduction.md, and extending the canonical category line to GitHub About /pyprojectdescriptions / site metadata.🤖 Generated with Claude Code