Mechanical rename produced by scripts/msd-rename.cjs: gsd/Gsd/GSD -> msd/Msd/MSD across contents and paths, upstream package/repo coordinates -> @golem15/msd-core and golem15com/msd-core. Deep links into upstream history, sibling upstream packages, the GSD-2 import feature, CHANGELOG.md and .changeset/ are kept as-is. Hand edits on top: MSD block-letter banner and logos, LICENSE copyright line, package/plugin identity, regenerated lockfile, install-tree fixtures, derived registries and benchmark baseline; migration checksum baseline re-locked (MSD keeps its own install state, so no install had applied the old sums); sort-order and regex-escaped expectations in tests adjusted.
26 lines
1.7 KiB
Markdown
26 lines
1.7 KiB
Markdown
---
|
|
id: 27b
|
|
title: Existing Codebase Onboarding
|
|
group: Brownfield Features
|
|
order: 27.1
|
|
---
|
|
|
|
**Command:** `/msd-onboard [--fast] [--text]`
|
|
|
|
**Purpose:** Guide first-time setup for an existing repository by checking brownfield state, routing through codebase mapping and docs ingest, then handing off to project initialization without silently overwriting planning artifacts.
|
|
|
|
**Requirements:**
|
|
- REQ-ONBOARD-01: System MUST detect existing code, package manifests, planning documents, partial `.planning/` state, and complete or missing codebase-map files.
|
|
- REQ-ONBOARD-02: System MUST hand off to `/msd-map-codebase` or `/msd-map-codebase --fast` when brownfield code lacks the required `.planning/codebase/` map files; fast-map readiness is partial and MUST NOT be treated as sufficient for `/msd-new-project`.
|
|
- REQ-ONBOARD-03: System MUST offer `/msd-ingest-docs` before `/msd-new-project` when ADR/PRD/SPEC/RFC candidates exist and no project exists.
|
|
- REQ-ONBOARD-04: System MUST refuse to report onboarding complete until `PROJECT.md`, `REQUIREMENTS.md`, `ROADMAP.md`, and `STATE.md` all exist.
|
|
- REQ-ONBOARD-05: System MUST create or confirm `.planning/onboarding/SUMMARY.md` only after project setup exists.
|
|
- REQ-ONBOARD-06: System MUST support `--text` for numbered plain-text gates on runtimes without interactive menus.
|
|
|
|
**Produces:**
|
|
| Artifact | Description |
|
|
|----------|-------------|
|
|
| `.planning/codebase/` | Codebase map produced by the `/msd-map-codebase` handoff |
|
|
| `.planning/PROJECT.md`, `REQUIREMENTS.md`, `ROADMAP.md`, `STATE.md` | Planning setup produced by `/msd-new-project` or `/msd-ingest-docs` |
|
|
| `.planning/onboarding/SUMMARY.md` | Onboarding status, artifact index, and next-command summary |
|