Skip to content

#239 [Docs]: Retire QUICKSTART.md — fold its unique content into USAGE_GUIDE and CONFIGURATION - #360

Draft
isolomatov-gd wants to merge 2 commits into
mainfrom
feature/issue-239-retire-quickstart
Draft

isolomatov-gd wants to merge 2 commits into
mainfrom
feature/issue-239-retire-quickstart

Conversation

@isolomatov-gd

Copy link
Copy Markdown
Contributor

Closes #239

Summary

  • Retire the duplicate root QUICKSTART.md and route the README quick start to the canonical install, initialize, configure, and usage guidance.
  • Preserve the unique requirements extract/update, modernization phase, and focused-subagent validation guidance in USAGE_GUIDE.md; add configuration onward links.
  • Repoint inbound documentation links, update the documentation contract and code map, and change the legacy compatibility notice to the MCP guide.
  • Add focused compatibility-notice coverage.

Testing

  • git diff --check
  • Direct focused compatibility-notice test invocation (the repository virtual environment and system pytest are unavailable)
  • Public MCP guide URL returned HTTP 200
  • Whole-repository QUICKSTART reference sweep with approved historical, website, generated-instruction/plugin, and [ROSETTA] rosetta-cli README Tag-in-Title docs stale vs code #206 CLI exclusions

Assumptions

@github-actions

Copy link
Copy Markdown
Contributor

Rosetta Triage Review

Summary: Retires the duplicate root QUICKSTART.md, makes README the concise install → initialize → configure → use route, and moves its unique workflow guidance to the canonical usage and configuration pages. It also repoints the legacy MCP compatibility notice to MCPs.md and adds focused coverage.

Findings:

  • No blocking defects found in the changed scope.
  • Verified the replacement anchors for README Quick Start, installation bootstrap/initialization, MCP connection, configuration modernization setup, and Usage Guide workflow/best-practice guidance.
  • The candidate tree has no live, non-excluded QUICKSTART.md reference in the active root documentation set; retained website, provenance, generated-plugin, instruction-vocabulary, and CLI references match the issue's explicit exclusions.
  • git diff --check is clean. The required build-test and CodeQL checks are passing; automated security checks were consulted with no PR-diff concern identified.

Caveats:

Automated triage by Rosetta agent

…README

- QUICKSTART.md stays deleted; main's only change (model names) is already in README/INSTALLATION/PLUGINS/MCPs/FAQ.
- Website quickstart page now mirrors README "Quick Start"; sync skill and sync_user_guide_web.py updated.
- Fix FAQ #model-selection dangling anchor; drop QUICKSTART.md from .dockerignore.
- Bump rosetta-mcp-server 3.0.5 -> 3.0.6 (3.0.5 is published).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@isolomatov-gd

Copy link
Copy Markdown
Contributor Author

Converting to draft.

QUICKSTART.md exists for a reason: README.md carries too much context for a quick start. The design step was skipped. Before removing QUICKSTART.md, decide how the whole documentation set should work for both humans and AI agents, then restructure from that.

Merged main and fixed the review findings in 30823a5: the website Quick Start page now syncs from the README Quick Start section, the broken FAQ anchor is removed, the .dockerignore entry is removed, and rosetta-mcp-server is bumped to 3.0.6.

@isolomatov-gd
isolomatov-gd marked this pull request as draft October 19, 2026 17:11

This branch has not been deployed

No deployments
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.

[Docs]: Retire QUICKSTART.md — fold its unique content into USAGE_GUIDE and CONFIGURATION

1 participant