docs: rewrite Quick Start as short developer guide (CTORNDGAIN-1301)#82
docs: rewrite Quick Start as short developer guide (CTORNDGAIN-1301)#82ymakaruk-pixel wants to merge 18 commits into
Conversation
ymakaruk-pixel
commented
May 12, 2026
- Plugin-first install; MCP demoted to labeled fallback
- Bootstrap rule promoted to mandatory step for MCP mode
- Real example regenerated as in coding-flow.md
- New Customize page with examples - needs review and testing
Rosetta Triage ReviewSummary: This PR rewrites the Quick Start page as a developer-focused Overview with a plugin-first install path, demotes MCP to a fallback, and adds a new Customize page (209 lines) covering context files, project rules, and helper MCPs — all as website documentation changes only (no code logic modified). Findings:
Suggestions:
Automated triage by Rosetta agent |
edc35b6 to
665c208
Compare
isolomatov-gd
left a comment
There was a problem hiding this comment.
Please double check the PR
| @@ -0,0 +1,5 @@ | |||
| { | |||
There was a problem hiding this comment.
Remove this from commit
| --- | ||
|
|
||
| # Coding Flow | ||
| # Coding workflow |
There was a problem hiding this comment.
I think we cut too much from coding-flow.
Why did we rename Flow -> workflow ?
| baseSchema: docs/schemas/rule.md | ||
| --- | ||
|
|
||
| <bootstrap_rosetta_files compact="NEVER" optimize="NEVER" summarize="AS-IS"> |
There was a problem hiding this comment.
Why this file was modified?
5fe0a19 to
b141495
Compare
| ## Still Stuck? | ||
|
|
||
| - [FAQ.md](FAQ.md) — common questions about behavior, token usage, and concepts | ||
| - [Discord](https://discord.gg/QzZ2cWg36g) |
| | **Workflow** | Multi-phase pipeline coordinating subagents for a specific request type. Defines phases, steps, and approval gates. Alias **Command** | | ||
| | **Skill** | Reusable unit of work loaded into agents on demand. Skills define *how* to accomplish a specific task. | | ||
| | **Rule** | Persistent constraint applied globally or by path pattern. Defines best practices, guardrails, guidelines. | | ||
| | **Subagent** | Delegated specialist with fresh context and its own system prompt. Alias: **Agent**. Examples: orchestrator, planner, executor, and others. | |
There was a problem hiding this comment.
we don't have orchestrator as a subagent. let's choose one from the list.
This might lead users to think that Rosetta is acting as an orchestrator.
| Complete the OAuth flow when prompted. Then ask: *"Initialize this repository using Rosetta"* | ||
| Other IDEs and STDIO transport: see [INSTALLATION.md](INSTALLATION.md). Any MCP-compatible tool can connect using the same endpoint. | ||
|
|
||
| **Then add the bootstrap rule (MCP mode only).** Some IDEs don't reliably invoke MCP tools on their own. Download [bootstrap.md](https://github.com/griddynamics/rosetta/blob/main/instructions/r2/core/rules/bootstrap.md?plain=1) and place it where your IDE looks for instructions (e.g. `.claude/claude.md`, `.cursor/rules/bootstrap.mdc`, `.github/copilot-instructions.md`). Full path table in [QUICKSTART.md](QUICKSTART.md). |
There was a problem hiding this comment.
Can we changed 'r2' in url on some the summary value of the current version? I would like to avoid changed it every time
- Plugin-first install; MCP demoted to labeled fallback - Bootstrap rule promoted to mandatory step for MCP mode - Real example regenerated against canonical coding-flow.md - New Customize page with worked examples (CONTEXT.md, rules, MCPs) - Sidebar + docs index updated to include Customize Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Cross-checked against docs/web/docs/coding-flow.md per Igor's review request: - Phase names: "Specs + plan" → "Tech plan"; "Plan review" → "Review plan"; "Code review" → "Review code"; "Tests review" → "Review tests" - Artifact names use <FEATURE>-SPECS.md / <FEATURE>-PLAN.md placeholder with plans/PASSWORD-RESET/ as the concrete example - Prompt updated to "Add password reset support to the customer portal. I want to review the plan first." (matches canonical "How To Start" style) - Added scaling footnote: small tasks handle some phases inline and may combine the two HITL gates; approval still always explicit - Linked to /docs/coding-flow/ for canonical phase reference Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- What is Rosetta: cut meta-prompting/four-phase jargon; replaced with plain definition + concrete usage example + IDE list inline. - Why use it: 6 slogan-led bullets to 4 benefit-led bullets; demoted cross-project intelligence to a small italic callout. - How it works: cut duplicate privacy paragraphs and 3 security control bullets (kept in SECURITY.md); added plugin/MCP delivery split with plugin recommended (clients prefer plugins). - Get Started: plugin-first install (Option A) with MCP fallback (Option B); added model-choice warning and mandatory bootstrap rule step for MCP mode; merged verify and initialize. - Cut redundant "Supported IDEs and Agents" section; "any MCP- compatible tool" folded into Option B. - Documentation table: row labels cleaned up for verb consistency and reordered (security before changelog). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Updated OVERVIEW.md to link to TERMINOLOGY.md - Enhanced PLUGINS.md with clearer installation instructions and warnings. - fix QUICKSTART.md for first-time users, emphasizing project initialization and common issues. - Added FAQ.md to address common questions and installation issues. - Revised REVIEW.md to ensure consistent terminology referencing TERMINOLOGY.md. - Improved TROUBLESHOOTING.md with additional guidance and links to FAQ.md. - Clarified architecture details in ARCHITECTURE.md and updated references to terminology. - Adjusted bootstrap rules in instructions to reflect Git instead of SCM for file exclusions.
Local Claude Code IDE config shouldn't be committed; gitignoring it alongside the existing .cursor/mcp.json pattern. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Add user request step between Bootstrap and Classify in lifecycle diagram - Expand Execute step with four-phase bullets (Prepare/Research/Plan/Act) - Remove Evolve step from per-session lifecycle (it is a release-level concern) - Fix CONTEXT.md links in README.md to point to docs/CONTEXT.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…llation files and so on. Followed on comments made in github
78fe427 to
1e53b1f
Compare
|
|
||
| ### Where to put rules | ||
|
|
||
| | IDE | Path (any `.md` file works) | |
There was a problem hiding this comment.
| | IDE | Path (any `.md` file works) | | |
| | IDE | Path | |
isolomatov-gd
left a comment
There was a problem hiding this comment.
Pls see the rest of the comments + verify all contents
| **Playwright MCP** — drive a real browser, fill forms, click elements, scrape pages. | ||
|
|
||
| ```json | ||
| { "playwright": { "command": "npx", "args": ["-y", "@playwright/mcp@latest"] } } |
There was a problem hiding this comment.
| { "playwright": { "command": "npx", "args": ["-y", "@playwright/mcp@latest"] } } | |
| "playwright": { "command": "npx", "args": ["-y", "@playwright/mcp@latest"] } |
| { | ||
| "mcpServers": { | ||
| "Rosetta": { "url": "https://mcp.rosetta.griddynamics.net/mcp" }, | ||
| "Context7": { "url": "https://mcp.context7.com/mcp" } | ||
| } | ||
| } |
There was a problem hiding this comment.
| { | |
| "mcpServers": { | |
| "Rosetta": { "url": "https://mcp.rosetta.griddynamics.net/mcp" }, | |
| "Context7": { "url": "https://mcp.context7.com/mcp" } | |
| } | |
| } | |
| "Context7": { "url": "https://mcp.context7.com/mcp" } |
| **Chrome DevTools MCP** — full Chrome control: console, network tab, snapshots. | ||
|
|
||
| ```json | ||
| { "chrome-devtools": { "command": "npx", "args": ["-y", "chrome-devtools-mcp"] } } |
There was a problem hiding this comment.
| { "chrome-devtools": { "command": "npx", "args": ["-y", "chrome-devtools-mcp"] } } | |
| "chrome-devtools": { "command": "npx", "args": ["-y", "chrome-devtools-mcp"] } |
| Rosetta gives your AI coding agent your team's context, standards, and guardrails — across any IDE. | ||
|
|
||
| **When should I read this?** When you want to go from zero to a working setup. | ||
| You install Rosetta in your IDE, ask the agent "Initialize this repository using Rosetta", and it produces a plan + code + tests with the conventions of your codebase, not generic ones. |
There was a problem hiding this comment.
| You install Rosetta in your IDE, ask the agent "Initialize this repository using Rosetta", and it produces a plan + code + tests with the conventions of your codebase, not generic ones. | |
| You install Rosetta in your IDE, ask the agent "Initialize this repository using Rosetta", and during coding workflows it produces a plan + code + tests with the conventions of your codebase, not generic ones. |
| **When should I read this?** When you want to go from zero to a working setup. | ||
| You install Rosetta in your IDE, ask the agent "Initialize this repository using Rosetta", and it produces a plan + code + tests with the conventions of your codebase, not generic ones. | ||
|
|
||
| > **Use a strong model.** Sonnet 4.6, GPT-5.3-codex-medium, gemini-3.1-pro, or better. Avoid Auto. Weaker models silently skip Rosetta's tools. |
There was a problem hiding this comment.
| > **Use a strong model.** Sonnet 4.6, GPT-5.3-codex-medium, gemini-3.1-pro, or better. Avoid Auto. Weaker models silently skip Rosetta's tools. | |
| > [!WARNING] | |
| > You must receive a prior approval from your manager and company to use it. | |
| > [!WARNING] | |
| > Use **Sonnet 4.6**, **GPT-5.3-codex-medium**, **gemini-3.1-pro** or better models. Avoid Auto model selection. | |
| > [!NOTE] | |
| > Rosetta is designed to never use or see data or IP. | |
| > Instead it uses inversion of control, by providing a "menu" to AI coding agents. |
|
|
||
| **R2** is the current stable release — use it for production work. | ||
|
|
||
| **R3** is in active development and not for production use yet. (Internal contributors testing R3 do so by switching to the `V3` branch — see [DEVELOPER_GUIDE.md](DEVELOPER_GUIDE.md).) |
There was a problem hiding this comment.
R3/V3 branch and so on - remove, this is not for users of rosetta
| Use the **plugin** when one is available for your IDE. Plugins bundle the bootstrap rule, skills, agents, and workflows directly into the IDE and the agent loads them locally — no live connection to a Rosetta server at request time. In practice this means: | ||
|
|
||
| - Faster session start, no MCP OAuth expirations dropping the agent mid-task, no dependency on the Rosetta server being reachable from your network. | ||
| - No outbound calls to an external service means no data-egress or privacy review — you're installing static instruction files into the repo. That's a much shorter conversation with security and compliance than authorizing a new external MCP endpoint. |
There was a problem hiding this comment.
| - No outbound calls to an external service means no data-egress or privacy review — you're installing static instruction files into the repo. That's a much shorter conversation with security and compliance than authorizing a new external MCP endpoint. | |
| - No outbound calls to an external service means no data-egress or privacy review — you're using local static instruction files. That's a much shorter conversation with security and compliance than authorizing a new external MCP endpoint. |
|
|
||
| Yes, but with a purpose. Rosetta loads bootstrap rules, the workflow for your request type, and any skills needed for the task — typically a few thousand extra tokens up front. In return you get: | ||
|
|
||
| - Fewer wrong-path executions that would burn far more tokens being undone |
There was a problem hiding this comment.
Guardrails, Security, Sensitive Data handling, current config risk assessment, reliable results.
|
|
||
| - Fewer wrong-path executions that would burn far more tokens being undone | ||
| - Less back-and-forth because the agent asks the right questions early (HITL) | ||
| - Reusable plans, specs, and memory that compound across sessions |
There was a problem hiding this comment.
| - Reusable plans, specs, and memory that compound across sessions | |
| - Spec-Driven Development extended with Discovery, Design, Review, and Validation phases | |
| - Reusable agent memory that allows AI to learn on current repo |
| - Less back-and-forth because the agent asks the right questions early (HITL) | ||
| - Reusable plans, specs, and memory that compound across sessions | ||
|
|
||
| For small/trivial tasks the overhead can feel high relative to the task. For medium/large tasks the overhead is small relative to total work and the reliability gain usually pays for itself. <!-- TODO: link to any published benchmarks if available --> |
There was a problem hiding this comment.
| For small/trivial tasks the overhead can feel high relative to the task. For medium/large tasks the overhead is small relative to total work and the reliability gain usually pays for itself. <!-- TODO: link to any published benchmarks if available --> | |
| For small/trivial tasks AI treats them as just small change and never executes tests nor validate results of changes. Very often small changes have side effects, which AI must figure out first. This leads to low quality unpredictable results. |
isolomatov-gd
left a comment
There was a problem hiding this comment.
Pls see the rest of the comments + verify all contents