docs: restructure README around the user journey - #238
Conversation
Rosetta Triage ReviewSummary: Reorders the README around what a reader does (decide → install → initialize → run a workflow) instead of leading with positioning content, folds Findings:
Caveats:
Automated triage by Rosetta agent |
7bde800 to
020dce9
Compare
Reorder the README so a reader reaches something actionable immediately instead of scrolling past positioning material. - Lead with what Rosetta changes about the agent's behaviour, then a "Do you need it?" block so the decision to continue or stop happens before install. The intro video is collapsed, inline. - Quick start: four numbered steps (install, initialize, review and commit the generated context, run your first workflow). Per-IDE install is one table. Committing the generated files is now its own step rather than an aside. - Add "The recommended path": the five steps of a real task (context -> pin down what to build -> implement -> test -> check before ship), each with the workflows that fit and example prompts, and two recordings of it on real projects. Covers all 14 active workflows; previously only 7 were listed. - Add "What's inside: the skill library" covering the R3 core skills, including the always-on set that backs each guardrail. - Replace the routing table with "Go deeper": one collapsed table of every document and what it is for, including FAQ, ELEVATOR_PITCH, REVIEW, docs/CONTEXT, docs/MCP-ARCHITECTURE and llms-full.txt, none of which were linked before. - Drop the positioning material (comparison tables, layering diagram, "why not IDE rules", the 12-point collapsible) and the Contributing section. That ground is covered by OVERVIEW.md and docs/CONTEXT.md, both linked from Go deeper. CONFIGURATION.md is cleaned up to match, since the README now sends readers there for workspace setup: - Remove the "Install and Onboard" section and every Quick Start reference. Installing and initializing are covered before a reader reaches this page, and repeating them here is how the two drifted. - Renumber the remaining sections and add a short overview list of the five setup steps, so the page opens with what it actually asks of you. QUICKSTART.md is left untouched. The README now carries the same happy path inline, so the two overlap; that is recorded in the PR description rather than resolved here. Closes #216 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
020dce9 to
01cf34c
Compare
YevheniiaLementova
left a comment
There was a problem hiding this comment.
I've left several suggestions, otherwise LGTM!
There was a problem hiding this comment.
This is definitely a step in the right direction, but it is just rephrasing what we had. We need genuinely new good README.md as we talked with important notes on what/why rosetta does something really better.
Example: Discovery phase in coding-flow finds genuine issues and artifacts, design phases allows to select one of three best designs, makes AI follow your intent, etc.
Replace the walkthrough-style README with a shorter version that routes instead of explaining: install in three numbered steps with a recognizable success signal, four "why this exists" sections written as problems, and a workflow reference grouped by intent. - Drop the publish-rosetta-mcp and publish-rosetta-cli CI badges - Move /init-workspace-flow out of the reference tables: it is a precondition, not one of the "what I want to do" choices, so it now sits under the axis statement and links back to Install - Rename "Set up, and when you are stuck" to "When you are stuck" Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Restore CONFIGURATION.md to its state on main. The README restructure had renumbered its sections and removed the Quick Start pointers next to each "Initialize Rosetta" action; that is a separate concern and belongs in its own PR, per CONTRIBUTING's one-concern-per-PR rule. This also restores the token-saving tip, which had been deleted here on the grounds that the README quick start carried it. The rewritten README does not carry it, so it currently exists nowhere. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
9315d7d to
0fdab6d
Compare
Wrap the documentation index in <details> so it does not compete with the install and reference sections, and list every document instead of a subset. Adds PLUGINS.md, MCPs.md, INSTALLATION.md, ELEVATOR_PITCH.md, CHANGELOG.md, REVIEW.md, docs/CONTEXT.md and docs/mcp/DEPLOYMENT_GUIDE.md, taking coverage of root-level docs from 10 of 15 to 15 of 15. Rows are ordered by where the reader is: install, configure, use, understand, recover, build on it, contribute, security. Drops the trailing "Not here:" sentence, which listed directories rather than answering a reader's question and mixed instruction sources with working material already covered by DEVELOPER_GUIDE.md. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Only README.md overlapped: main changed 252 files, this branch 1. main's README edits and this branch's rewrite could not be merged line by line, because the branch replaces the file wholesale. Resolved by keeping the rewritten README and composing in main's actual contribution, the new 20-file user-guide/: - a pointer to the User Guide after the install steps, where a new reader asks "now what?" - a row in the documentation table - USAGE_GUIDE.md's row reworded to "the full reference, every workflow phase by phase", so it no longer competes with the User Guide for the "day to day" slot that main's own table gave to user-guide/ Verified after the merge: 53 markdown files, 451 relative links and 114 anchors resolve, 0 broken. The user-guide/ links to README.md#scenarios-at-a-glance are relative to user-guide/ and resolve to its own README, not the root one. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Closes #216.
Two files:
README.md(the restructure) andCONFIGURATION.md(cleanup, because the README now sends readers there).README
It opened with positioning material — hero video, "What is Rosetta", a layering diagram, comparison tables, a 12-point collapsible — before a reader reached anything they could act on. This reorders it around what a reader actually does: decide whether they need it, install it, run something.
Intro — what Rosetta changes about the agent's behaviour, then a
Do you need it?block with five concrete symptoms, so the stop-or-continue decision happens before install rather than after scrolling. The intro video is collapsed, inline.Quick start — four numbered steps: install, initialize, review and commit the generated context, run your first workflow. Per-IDE install is one table. Committing the generated files is now its own step; previously it was one clause inside a paragraph, and it is the step people skip.
The recommended path — new section covering the five steps of a real task: get context → pin down what to build → implement → test → check before it ships. Each lists the workflows that fit, with example prompts, and the section ends with two recordings of the path on real projects. All 14 active workflows are represented; the old
Top Workflowslist had 7 and omittedmodernization-flow,research-flow,adhoc-flow,external-lib-flow, andcoding-agents-prompting-flow.What's inside: the skill library — the R3 core skills grouped by purpose, including an
Always activegroup that names the skill behind each guardrail. The oldTop Guardrailslist described behaviours without saying where they came from.Go deeper — one collapsed table of every document and what it is for. Adds
FAQ.md,ELEVATOR_PITCH.md,REVIEW.md,docs/CONTEXT.md,docs/MCP-ARCHITECTURE.md, andllms-full.txt, none of which were linked from the README before.Removed — the comparison tables, the layering diagram, "Why not just use IDE rules?", "Who benefits", the 12-point collapsible, and the
Contributingsection. That ground is covered byOVERVIEW.mdanddocs/CONTEXT.md, both linked from Go deeper.CONFIGURATION.md
The README now points here as the thing to do before real work, so the page had to stop repeating what precedes it.
Install and Onboardsection is removed, along with all fiveQuick Startreferences. Installing and initializing happen before a reader gets here; carrying a second copy of those steps is how the two documents drifted apart in the first place.Set Up the Repository→ 1,Choose a Workspace Layout→ 2,Modernization Additional Setup→ 3), and the internal link to the modernization section updated.No existing wording was rewritten — only removed, renumbered, or linked.
Known overlap, deliberately not addressed here
The issue offered two options for QUICKSTART. This PR takes neither —
QUICKSTART.mdis untouched. The README now carries the same happy path inline, so both documents describe install and first-run.docs/reviews/DOC-STRUCTURE-PLAN.mdis also untouched, so its README contract (which lists "full install steps" and "workflow how-tos" underExcludes) and its open items §5.1 and §5.4 still read as they did before this PR. Both were flagged in the triage comment on #216.Reconciling the plan and deciding QUICKSTART's fate is follow-up work.
Review notes
SECURITY.md; workflow descriptions come frominstructions/r3/core/workflows/; the skill list matchesinstructions/r3/core/skills/.git addline in step 3 uses a<placeholder>rather than an enumerated file list, since the canonical committed-vs-excluded list lives inINSTALLATION.mdand would drift if copied.PLUGINS.md,MCPs.md,INSTALLATION.md,QUICKSTART.md, and thedocs/web/mirrors.docs/web/mirrors of these pages are not updated here.🤖 Generated with Claude Code