Skip to content

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

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

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

Conversation

@ymakaruk-pixel
Copy link
Copy Markdown

@ymakaruk-pixel 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

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

github-actions Bot commented May 12, 2026

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 3 times, most recently from 5ab14d8 to edc35b6 Compare May 14, 2026 15:00
Yuri and others added 6 commits May 18, 2026 15:51
@claude
docs: rewrite Quick Start as short developer guide (CTORNDGAIN-1301)
72c093d 
- 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>
@claude
docs: align Quick Start example with canonical coding-flow.md
c351d71 
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>
docs: refine Coding workflow section for clarity and conciseness
c8d8a96
@claude
docs: rewrite README for developer-first reading (CTORNDGAIN-1301)
251e181 
- 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>
docs: update contributing guidelines and developer documentation for …
544da15 
…clarity
- Consolidated key concepts into a new TERMINOLOGY.md .
665c208 
- 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.
@ymakaruk-pixel ymakaruk-pixel force-pushed the CTORNDGAIN-1301-quickstart-rewrite branch from edc35b6 to 665c208 Compare May 18, 2026 12:52
isolomatov-gd
isolomatov-gd requested changes May 19, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@isolomatov-gd isolomatov-gd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please double check the PR

Comment thread .claude/settings.local.json Outdated
@@ -0,0 +1,5 @@
{
Copy link
Copy Markdown
Contributor

@isolomatov-gd isolomatov-gd May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this from commit

Comment thread docs/web/docs/coding-flow.md
---

# Coding Flow
# Coding workflow
Copy link
Copy Markdown
Contributor

@isolomatov-gd isolomatov-gd May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we cut too much from coding-flow.
Why did we rename Flow -> workflow ?

Comment thread instructions/r2/core/rules/bootstrap-rosetta-files.md
@@ -10,7 +10,7 @@ baseSchema: docs/schemas/rule.md

<bootstrap_rosetta_files compact="NEVER" optimize="NEVER" summarize="AS-IS">
Copy link
Copy Markdown
Contributor

@isolomatov-gd isolomatov-gd May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this file was modified?

@claude
chore: untrack .claude/settings.local.json and add to .gitignore
d8ce792 
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@isolomatov-gd isolomatov-gd isolomatov-gd requested changes

@ElizaVetaFomka ElizaVetaFomka Awaiting requested review from ElizaVetaFomka ElizaVetaFomka is a code owner

@YevheniiaLementova YevheniiaLementova Awaiting requested review from YevheniiaLementova YevheniiaLementova is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ymakaruk-pixel @isolomatov-gd