Skip to content

docs: rewrite Quick Start as short developer guide (CTORNDGAIN-1301)#82

Open
ymakaruk-pixel wants to merge 5 commits into
mainfrom
CTORNDGAIN-1301-quickstart-rewrite
Open

docs: rewrite Quick Start as short developer guide (CTORNDGAIN-1301)#82
ymakaruk-pixel wants to merge 5 commits into
mainfrom
CTORNDGAIN-1301-quickstart-rewrite

Conversation

@ymakaruk-pixel
Copy link
Copy Markdown

  • 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

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 12, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Rosetta Triage Review

Summary: 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:

  • Scope: Focused and coherent — 4 files changed, all in docs/web/. Adds a new Customize guide and substantially rewrites the Quick Start page.
  • Description: Adequately describes the 4 key changes; the author notes the Customize page "needs review and testing," which aligns with the documentation label added.
  • Breaking changes: None to code or APIs. The Quick Start page H1 was renamed from "Quick Start" to "Overview" — users with bookmarked anchor links to that heading may be affected.
  • Documentation: This PR is the documentation; no public API or code changes require additional docs.
  • Test coverage: No tests applicable — Jekyll docs site only.
  • Internal links: Several links in customize.md reference /rosetta/docs/architecture/ and /rosetta/docs/quickstart/ — the latter is unchanged in permalink (/docs/quickstart/) so it resolves correctly. Worth a local Jekyll build to confirm all relative links render properly.

Suggestions:

  • Run a local Jekyll build (bundle exec jekyll serve) to verify the new Customize page renders, the sidebar Customize link appears in the correct position, and all internal cross-links resolve.
  • Consider whether renaming the Quick Start H1 to "Overview" matches user expectations — returning users navigating by heading may find this confusing; the permalink /docs/quickstart/ is unchanged which is good.
  • The PR body mentions "Real example regenerated as in coding-flow.md" — confirm the example in the new quickstart.md accurately reflects the current coding workflow steps.

Automated triage by Rosetta agent

@ymakaruk-pixel ymakaruk-pixel force-pushed the CTORNDGAIN-1301-quickstart-rewrite branch 2 times, most recently from da63cee to 28f5321 Compare May 14, 2026 10:40
Yuri and others added 5 commits May 14, 2026 17:59
- 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>
@ymakaruk-pixel ymakaruk-pixel force-pushed the CTORNDGAIN-1301-quickstart-rewrite branch from 5ab14d8 to edc35b6 Compare May 14, 2026 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant