Skip to main content

Sprint 2 — Documentation Foundation Validation

Objective and scope​

Sprint 2 consolidates the learning, installation, and getting-started experience (Learn, Installation & Getting Started) for developers and teams adopting Rapid OS v3.0.0.


Documentation coverage matrix (Sprint 2)​

AreaImplemented documentCanonical pathStatus
What RAPID OS isWhat is RAPID OSdocs/concepts/what-is-rapid-os.mdVerified
Problem and benefitsWhy RAPID OSdocs/concepts/why-rapid-os.mdVerified
Core conceptsCore Conceptsdocs/concepts/core-concepts.mdVerified
Limits and boundariesProduct Boundariesdocs/concepts/product-boundaries.mdVerified
System requirementsRequirementsdocs/installation/requirements.mdVerified
WindowsInstallation Windowsdocs/installation/windows.mdVerified
LinuxInstallation Linuxdocs/installation/linux.mdVerified
macOSInstallation macOSdocs/installation/macos.mdVerified
WSLInstallation WSLdocs/installation/wsl.mdVerified
VerificationInstallation Verificationdocs/installation/verification.mdVerified
UpgradeUpgradedocs/installation/upgrade.mdVerified
First projectFirst Project (Quickstart)docs/getting-started/first-project.mdVerified
Existing projectExisting Projectdocs/getting-started/existing-project.mdVerified
First SpecFirst Specdocs/getting-started/first-spec.mdVerified
First ContextFirst Contextdocs/getting-started/first-context.mdVerified
Next stepsNext Steps in Governancedocs/getting-started/next-steps.mdVerified
Common problemsTroubleshooting Installationdocs/troubleshooting/installation.mdVerified

Acceptance criteria (Definition of Done)​

  • Product Truth: The purpose, capabilities, and limits of Rapid OS are explained clearly, without hallucinated claims of autonomous behavior or LLM-as-a-judge.
  • Cross-platform installation: Detailed step-by-step guides for Windows, Linux, macOS, and WSL 2.
  • Version differentiation: Explicit distinction between the stable version (v3.0.0) and the development version (main).
  • Reproducible Quickstart tutorial: Step-by-step guided tutorial with a minimal project, functionally tested in CI using an isolated temporary directory.
  • Adoption in existing repositories: Non-invasive guide that preserves business code and uses .bak backups.
  • Automated contracts and tests: 11 documentation contract tests in Python with no Node.js dependencies, covering file integrity, valid flags, and lockfile consistency.
  • RAPID OS test suite intact: 301/301 tests passing.
  • Docusaurus build: npm run typecheck and npm run build pass with no type warnings or broken internal links (onBrokenLinks: 'throw').