refactor: project onboard routing in init
This commit is contained in:
Jeremy McSpadden
committed by
Codesmith
Codesmith
parent
e3f2070a42
commit
a5298c1fc0
@@ -1,360 +1,219 @@
|
||||
<purpose>
|
||||
Guide existing-codebase onboarding by sequencing the already-owned GSD primitives:
|
||||
`/gsd:map-codebase`, `/gsd:ingest-docs`, and `/gsd:new-project`. The workflow is
|
||||
idempotent: it confirms existing artifacts, refuses to overwrite planning data silently,
|
||||
and stops with the exact next top-level command whenever a nested interactive workflow
|
||||
would be unsafe.
|
||||
</purpose>
|
||||
# /gsd:onboard Workflow
|
||||
|
||||
<required_reading>
|
||||
Read all files referenced by the invoking prompt's execution_context before starting.
|
||||
</required_reading>
|
||||
One-command onboarding for an existing or unknown repo. This workflow is a thin
|
||||
renderer around `init onboard`; deterministic routing lives in the CLI projection.
|
||||
|
||||
<process>
|
||||
@~/.claude/gsd-core/references/gsd-run-resolver.md
|
||||
|
||||
## 1. Initialize
|
||||
|
||||
Display banner:
|
||||
|
||||
```
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
GSD ► ONBOARDING
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
```
|
||||
## 1. Render the Onboarding Projection
|
||||
|
||||
Parse `$ARGUMENTS`:
|
||||
- `--fast` sets `MAP_COMMAND` to `/gsd:map-codebase --fast`, passes `--fast` to the init projection, and accepts the default fast map subset (STACK, INTEGRATIONS, ARCHITECTURE, STRUCTURE) as sufficient onboarding context; otherwise `MAP_COMMAND` is `/gsd:map-codebase`.
|
||||
- `--text` sets `TEXT_MODE=true`.
|
||||
- `--fast` passes `--fast` to `init onboard`. Fast mode accepts the fast map for lightweight onboarding only; `next_action` still decides whether complete map work is required before project setup.
|
||||
- `--text` forces text-mode choices for runtimes without `AskUserQuestion`.
|
||||
|
||||
Run the init projection:
|
||||
|
||||
```bash
|
||||
_GSD_SHIM_NAME="gsd-tools.cjs"; _GSD_RUNTIME_ROOT="${RUNTIME_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)}"; GSD_TOOLS="${_GSD_RUNTIME_ROOT}/gsd-core/bin/${_GSD_SHIM_NAME}"; if [ -f "$GSD_TOOLS" ]; then gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${_GSD_RUNTIME_ROOT}/.claude/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${_GSD_RUNTIME_ROOT}/.claude/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${_GSD_RUNTIME_ROOT}/.codex/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${_GSD_RUNTIME_ROOT}/.codex/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif command -v gsd-tools >/dev/null 2>&1; then GSD_TOOLS="$(command -v gsd-tools)"; gsd_run() { "$GSD_TOOLS" "$@"; }; elif [ -f "$HOME/.claude/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="$HOME/.claude/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${HERMES_HOME:-$HOME/.hermes}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${HERMES_HOME:-$HOME/.hermes}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${CURSOR_CONFIG_DIR:-$HOME/.cursor}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${CURSOR_CONFIG_DIR:-$HOME/.cursor}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${CODEX_HOME:-$HOME/.codex}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${CODEX_HOME:-$HOME/.codex}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${GEMINI_CONFIG_DIR:-$HOME/.gemini}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${GEMINI_CONFIG_DIR:-$HOME/.gemini}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${COPILOT_CONFIG_DIR:-$HOME/.copilot}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${COPILOT_CONFIG_DIR:-$HOME/.copilot}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${WINDSURF_CONFIG_DIR:-$HOME/.codeium/windsurf}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${WINDSURF_CONFIG_DIR:-$HOME/.codeium/windsurf}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${AUGMENT_CONFIG_DIR:-$HOME/.augment}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${AUGMENT_CONFIG_DIR:-$HOME/.augment}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${TRAE_CONFIG_DIR:-$HOME/.trae}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${TRAE_CONFIG_DIR:-$HOME/.trae}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${QWEN_CONFIG_DIR:-$HOME/.qwen}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${QWEN_CONFIG_DIR:-$HOME/.qwen}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${CODEBUDDY_CONFIG_DIR:-$HOME/.codebuddy}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${CODEBUDDY_CONFIG_DIR:-$HOME/.codebuddy}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${CLINE_CONFIG_DIR:-$HOME/.cline}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${CLINE_CONFIG_DIR:-$HOME/.cline}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${GROK_AGENTS_HOME:-$HOME/.agents}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${GROK_AGENTS_HOME:-$HOME/.agents}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${ANTIGRAVITY_CONFIG_DIR:-$HOME/.gemini/antigravity}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${ANTIGRAVITY_CONFIG_DIR:-$HOME/.gemini/antigravity}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${OPENCODE_CONFIG_DIR:-${XDG_CONFIG_HOME:-$HOME/.config}/opencode}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${OPENCODE_CONFIG_DIR:-${XDG_CONFIG_HOME:-$HOME/.config}/opencode}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; elif [ -f "${KILO_CONFIG_DIR:-${XDG_CONFIG_HOME:-$HOME/.config}/kilo}/gsd-core/bin/${_GSD_SHIM_NAME}" ]; then GSD_TOOLS="${KILO_CONFIG_DIR:-${XDG_CONFIG_HOME:-$HOME/.config}/kilo}/gsd-core/bin/${_GSD_SHIM_NAME}"; gsd_run() { node "$GSD_TOOLS" "$@"; }; else echo "ERROR: gsd-tools.cjs not found at $GSD_TOOLS and gsd-tools is not on PATH. Run: npx -y @opengsd/gsd-core@latest --claude --local" >&2; exit 1; fi; if [ -n "${CLAUDE_ENV_FILE:-}" ] && [ -n "${GSD_TOOLS:-}" ]; then printf "export PATH='%s':\"\$PATH\"\n" "${GSD_TOOLS%/*}" >> "$CLAUDE_ENV_FILE" 2>/dev/null || true; fi
|
||||
```
|
||||
|
||||
Run init from parsed prompt args, not shell `$ARGUMENTS`: `--fast` => `INIT=$(gsd_run --cwd "$_GSD_RUNTIME_ROOT" init onboard --fast)`; default omits `--fast`.
|
||||
Run the standard `gsd_run` resolver from the reference above, then run the projection from the runtime root:
|
||||
|
||||
```bash
|
||||
# If --fast was parsed from $ARGUMENTS:
|
||||
INIT=$(gsd_run --cwd "$_GSD_RUNTIME_ROOT" init onboard --fast --raw)
|
||||
# Otherwise:
|
||||
INIT=$(gsd_run --cwd "$_GSD_RUNTIME_ROOT" init onboard --raw)
|
||||
if [[ "$INIT" == @file:* ]]; then INIT=$(cat "${INIT#@file:}"); fi
|
||||
```
|
||||
|
||||
Parse JSON fields: `planning_exists`, `project_exists`, `requirements_exists`,
|
||||
`roadmap_exists`, `state_exists`, `has_existing_code`, `has_package_file`,
|
||||
`is_brownfield`, `fast_mode`, `has_codebase_map`, `has_fast_codebase_map`,
|
||||
`codebase_map_files_present`, `missing_codebase_map_files`, `missing_fast_codebase_map_files`,
|
||||
`has_docs_candidates`,
|
||||
`doc_candidate_count`, `onboarding_summary_exists`, `text_mode`, `commit_docs`, `agents_installed`,
|
||||
`missing_agents`, `has_git`, `git_worktree_root`, `in_nested_subdir`.
|
||||
Parse JSON fields from `INIT`:
|
||||
|
||||
Set `FAST_MODE=fast_mode` from INIT.
|
||||
Set `TEXT_MODE=true` if `--text` is present OR `text_mode` from INIT is true.
|
||||
Set `CODEBASE_MAP_READY=has_fast_codebase_map` when `FAST_MODE` is true; otherwise set
|
||||
`CODEBASE_MAP_READY=has_codebase_map`.
|
||||
- `next_action.kind`, `next_action.command`, `next_action.reason`, `next_action.missing`, `next_action.summary_path`
|
||||
- `map_readiness`, `codebase_map_summary_status`, `codebase_map_final_status`
|
||||
- `planning_exists`, `project_exists`, `requirements_exists`, `roadmap_exists`, `state_exists`
|
||||
- `is_brownfield`, `fast_mode`, `has_codebase_map`, `has_fast_codebase_map`
|
||||
- `missing_codebase_map_files`, `missing_fast_codebase_map_files`
|
||||
- `has_docs_candidates`, `doc_candidate_count`, `onboarding_summary_exists`
|
||||
- `commit_docs`, `text_mode`, `has_git`, `git_worktree_root`, `in_nested_subdir`
|
||||
|
||||
**Text mode (`workflow.text_mode: true` in config or `--text` flag):** When `TEXT_MODE` is active, replace every `AskUserQuestion` call in this workflow with a plain-text numbered list and ask the user to type their choice number. This is required for non-Claude runtimes (OpenAI Codex, Gemini CLI, etc.) where `AskUserQuestion` is not available and would otherwise render as an inert code block.
|
||||
Set:
|
||||
- `TEXT_MODE=true` if `--text` is present or `text_mode` is true.
|
||||
- `ONBOARDING_ROOT={git_worktree_root || _GSD_RUNTIME_ROOT}`.
|
||||
|
||||
## 2. Git and Existing Planning Safety
|
||||
If `has_git` and `in_nested_subdir` are true, warn that onboarding artifacts belong to the outer worktree at `git_worktree_root`. Do not run `git init`.
|
||||
|
||||
If `has_git` is true and `in_nested_subdir` is true, warn that onboarding artifacts will
|
||||
belong to the outer worktree at `git_worktree_root`. Do not run `git init` here.
|
||||
## 2. Execute `next_action`
|
||||
|
||||
If `planning_exists` is true, do not overwrite PROJECT/ROADMAP/STATE. Onboarding is
|
||||
idempotent and must only confirm or summarize existing files unless the user explicitly
|
||||
runs the lower-level refresh commands.
|
||||
### `map-codebase`
|
||||
|
||||
## 3. Codebase Mapping Gate
|
||||
|
||||
If `is_brownfield` is true and `CODEBASE_MAP_READY` is false:
|
||||
If `next_action.kind == "map-codebase"`:
|
||||
|
||||
- If `TEXT_MODE=true`, print:
|
||||
|
||||
```text
|
||||
Existing code was detected, but the required .planning/codebase/ map is missing.
|
||||
Missing map files: {--fast ? missing_fast_codebase_map_files : missing_codebase_map_files}
|
||||
{next_action.reason}
|
||||
Missing map files: {fast_mode ? missing_fast_codebase_map_files : missing_codebase_map_files}
|
||||
|
||||
1. Map codebase first — run {MAP_COMMAND} from worktree root {git_worktree_root || _GSD_RUNTIME_ROOT} to understand the repo before project setup (Recommended)
|
||||
1. Map codebase first — run {next_action.command} from worktree root {ONBOARDING_ROOT} (Recommended)
|
||||
2. Skip mapping — continue with weaker onboarding context
|
||||
|
||||
Enter number:
|
||||
```
|
||||
|
||||
Stop and wait for the user's reply.
|
||||
|
||||
- Otherwise use AskUserQuestion:
|
||||
- header: "Codebase"
|
||||
- question: "Existing code was detected, but the required .planning/codebase/ map is missing. Map it first?"
|
||||
- question: "{next_action.reason} Map it first?"
|
||||
- options:
|
||||
- "Map codebase first" — Run `{MAP_COMMAND}` from worktree root `{git_worktree_root || _GSD_RUNTIME_ROOT}` to understand the repo before project setup (Recommended)
|
||||
- "Map codebase first" — Run `{next_action.command}` from worktree root `{ONBOARDING_ROOT}` (Recommended)
|
||||
- "Skip mapping" — Continue with weaker onboarding context
|
||||
|
||||
If the user chooses mapping, do not nest the interactive map-codebase workflow. Print:
|
||||
If the user chooses mapping, do not nest the interactive workflow. Print:
|
||||
|
||||
```text
|
||||
Run from worktree root {git_worktree_root || _GSD_RUNTIME_ROOT}:
|
||||
Run from worktree root {ONBOARDING_ROOT}:
|
||||
|
||||
{MAP_COMMAND}
|
||||
{next_action.command}
|
||||
|
||||
Then rerun /gsd:onboard from the same worktree root.
|
||||
```
|
||||
|
||||
Exit.
|
||||
Exit. If the user skips mapping, continue with a warning.
|
||||
|
||||
If the user skips mapping, continue with a warning.
|
||||
### `ingest-docs`
|
||||
|
||||
If `is_brownfield` is false and `planning_exists` is false and `has_docs_candidates` is false, print:
|
||||
|
||||
```text
|
||||
No existing code was detected. For a greenfield project, run:
|
||||
|
||||
Run from worktree root {git_worktree_root || _GSD_RUNTIME_ROOT}:
|
||||
|
||||
/gsd:new-project
|
||||
```
|
||||
|
||||
Exit.
|
||||
|
||||
## 4. Existing Docs Gate
|
||||
|
||||
If `has_docs_candidates` is true and `project_exists` is false:
|
||||
If `next_action.kind == "ingest-docs"`:
|
||||
|
||||
- If `TEXT_MODE=true`, print:
|
||||
|
||||
```text
|
||||
{next_action.reason}
|
||||
Detected {doc_candidate_count} possible ADR/PRD/SPEC/RFC document(s).
|
||||
|
||||
1. Ingest docs first — run /gsd:ingest-docs from worktree root {git_worktree_root || _GSD_RUNTIME_ROOT} to bootstrap planning from existing docs (Recommended)
|
||||
1. Ingest docs first — run {next_action.command} from worktree root {ONBOARDING_ROOT} (Recommended)
|
||||
2. Skip docs ingest — continue to /gsd:new-project
|
||||
|
||||
Enter number:
|
||||
```
|
||||
|
||||
Stop and wait for the user's reply.
|
||||
|
||||
- Otherwise use AskUserQuestion:
|
||||
- header: "Docs"
|
||||
- question: "Detected {doc_candidate_count} possible ADR/PRD/SPEC/RFC document(s). Ingest them first?"
|
||||
- options:
|
||||
- "Ingest docs first" — Run `/gsd:ingest-docs` from worktree root `{git_worktree_root || _GSD_RUNTIME_ROOT}` to bootstrap planning from existing docs (Recommended)
|
||||
- "Ingest docs first" — Run `{next_action.command}` from worktree root `{ONBOARDING_ROOT}` (Recommended)
|
||||
- "Skip docs ingest" — Continue to `/gsd:new-project`
|
||||
|
||||
If the user chooses ingest, do not nest the interactive ingest-docs workflow. Print:
|
||||
If the user chooses ingest, print:
|
||||
|
||||
```text
|
||||
Run from worktree root {git_worktree_root || _GSD_RUNTIME_ROOT}:
|
||||
Run from worktree root {ONBOARDING_ROOT}:
|
||||
|
||||
/gsd:ingest-docs
|
||||
{next_action.command}
|
||||
|
||||
Then rerun /gsd:onboard from the same worktree root.
|
||||
```
|
||||
|
||||
Exit. If the user skips docs ingest, continue to the new-project handoff below.
|
||||
|
||||
### `complete-map-before-new-project`
|
||||
|
||||
If `next_action.kind == "complete-map-before-new-project"`, print:
|
||||
|
||||
```text
|
||||
{next_action.reason}
|
||||
|
||||
Run from worktree root {ONBOARDING_ROOT}:
|
||||
|
||||
{next_action.command}
|
||||
|
||||
Then rerun /gsd:onboard from the same worktree root.
|
||||
```
|
||||
|
||||
Exit.
|
||||
|
||||
## 5. Project Initialization Gate
|
||||
### `new-project`
|
||||
|
||||
If `project_exists` is false and `fast_mode && has_fast_codebase_map && !has_codebase_map` is true:
|
||||
|
||||
Print:
|
||||
If `next_action.kind == "new-project"`, print:
|
||||
|
||||
```text
|
||||
Fast codebase context is accepted for onboarding, but /gsd:new-project still requires the complete codebase map.
|
||||
{next_action.reason}
|
||||
|
||||
Run from worktree root {git_worktree_root || _GSD_RUNTIME_ROOT}:
|
||||
Run from worktree root {ONBOARDING_ROOT}:
|
||||
|
||||
/gsd:map-codebase
|
||||
|
||||
Then rerun /gsd:onboard from the same worktree root.
|
||||
{next_action.command}
|
||||
```
|
||||
|
||||
Exit.
|
||||
|
||||
If `project_exists` is false:
|
||||
### `partial-planning`
|
||||
|
||||
Print:
|
||||
If `next_action.kind == "partial-planning"`, print:
|
||||
|
||||
```text
|
||||
Codebase context is ready for project initialization.
|
||||
Project planning exists but is incomplete.
|
||||
|
||||
Run from worktree root {git_worktree_root || _GSD_RUNTIME_ROOT}:
|
||||
Missing files: {next_action.missing}
|
||||
REQUIREMENTS.md: {requirements_exists ? "present" : "missing"}
|
||||
ROADMAP.md: {roadmap_exists ? "present" : "missing"}
|
||||
STATE.md: {state_exists ? "present" : "missing"}
|
||||
|
||||
/gsd:new-project
|
||||
|
||||
Then rerun /gsd:onboard from the same worktree root.
|
||||
Run the appropriate lower-level command to fill the missing planning artifact(s), then rerun /gsd:onboard.
|
||||
```
|
||||
|
||||
Exit.
|
||||
|
||||
If `project_exists` is true and either `requirements_exists`, `roadmap_exists`, or
|
||||
`state_exists` is false, print:
|
||||
### `ready`
|
||||
|
||||
```text
|
||||
Existing PROJECT.md was found, but planning is incomplete.
|
||||
If `next_action.kind == "ready"`, print the final status section and exit.
|
||||
|
||||
Planning file status:
|
||||
- REQUIREMENTS.md: {requirements_exists ? "present" : "missing"}
|
||||
- ROADMAP.md: {roadmap_exists ? "present" : "missing"}
|
||||
- STATE.md: {state_exists ? "present" : "missing"}
|
||||
### `write-summary`
|
||||
|
||||
Run one of these top-level commands from worktree root {git_worktree_root || _GSD_RUNTIME_ROOT}:
|
||||
If `next_action.kind == "write-summary"`, continue to summary creation.
|
||||
|
||||
/gsd:ingest-docs --mode merge
|
||||
/gsd:new-milestone
|
||||
## 3. Create Onboarding Summary
|
||||
|
||||
Then rerun /gsd:onboard from the same worktree root.
|
||||
```
|
||||
Create `{ONBOARDING_ROOT}/{next_action.summary_path}`. Do not overwrite an existing summary; the projection should only route here when the summary is missing.
|
||||
|
||||
Exit. Do not write `.planning/onboarding/SUMMARY.md` and do not print the onboarding
|
||||
complete status for partial planning.
|
||||
|
||||
If `project_exists`, `requirements_exists`, `roadmap_exists`, and `state_exists` are all
|
||||
true, continue.
|
||||
|
||||
## 6. Write Onboarding Summary
|
||||
|
||||
Resolve `ONBOARDING_ROOT={git_worktree_root || _GSD_RUNTIME_ROOT}` before this step.
|
||||
Use `ONBOARDING_ROOT` for every filesystem write and commit in this step so nested-cwd
|
||||
invocations do not create `subdir/.planning` artifacts.
|
||||
|
||||
Create `{ONBOARDING_ROOT}/.planning/onboarding/SUMMARY.md` only after PROJECT.md exists.
|
||||
If it already exists, update it only after confirmation; do not overwrite silently.
|
||||
|
||||
Before summary keep/update choices, derive map status values safely:
|
||||
|
||||
- If `has_codebase_map` is true:
|
||||
- `CODEBASE_MAP_SUMMARY_STATUS=.planning/codebase/ (complete)`
|
||||
- `CODEBASE_MAP_FINAL_STATUS=(complete)`
|
||||
- Else if `fast_mode && has_fast_codebase_map` is true:
|
||||
- `CODEBASE_MAP_SUMMARY_STATUS=.planning/codebase/ (fast/partial-but-accepted codebase map)`
|
||||
- `CODEBASE_MAP_FINAL_STATUS=(fast/partial-but-accepted; required fast files present)`
|
||||
- Else:
|
||||
- `CODEBASE_MAP_SUMMARY_STATUS=.planning/codebase/ (incomplete or skipped)`
|
||||
- `CODEBASE_MAP_FINAL_STATUS=(incomplete or skipped; missing: {missing_codebase_map_files})`
|
||||
|
||||
If `onboarding_summary_exists` is true:
|
||||
|
||||
- If `TEXT_MODE=true`, print:
|
||||
|
||||
```text
|
||||
Onboarding summary already exists at .planning/onboarding/SUMMARY.md.
|
||||
|
||||
1. Update summary — regenerate from current artifact status (Recommended)
|
||||
2. Keep existing summary — skip writing
|
||||
|
||||
Enter number:
|
||||
```
|
||||
|
||||
Stop and wait for the user's reply.
|
||||
|
||||
- Otherwise use AskUserQuestion:
|
||||
- header: "Onboarding Summary"
|
||||
- question: "Onboarding summary already exists. Update it from current artifact status?"
|
||||
- options:
|
||||
- "Update summary" — Regenerate `.planning/onboarding/SUMMARY.md` (Recommended)
|
||||
- "Keep existing summary" — Skip writing
|
||||
|
||||
If the user chooses to keep the existing summary, skip to Step 7 without writing.
|
||||
|
||||
If `onboarding_summary_exists` is false or the user confirms an update, write the summary
|
||||
using the template below.
|
||||
|
||||
Summary contents:
|
||||
Summary template:
|
||||
|
||||
```markdown
|
||||
# Onboarding Summary
|
||||
|
||||
**Generated:** {YYYY-MM-DD}
|
||||
**Status:** Ready for GSD workflow
|
||||
## Project State
|
||||
- PROJECT.md: {project_exists ? "present" : "missing"}
|
||||
- REQUIREMENTS.md: {requirements_exists ? "present" : "missing"}
|
||||
- ROADMAP.md: {roadmap_exists ? "present" : "missing"}
|
||||
- STATE.md: {state_exists ? "present" : "missing"}
|
||||
|
||||
## Artifact Status
|
||||
## Codebase Context
|
||||
- Brownfield repo: {is_brownfield ? "yes" : "no"}
|
||||
- Map readiness: {map_readiness}
|
||||
- Codebase map: {codebase_map_summary_status}
|
||||
- Fast map available: {has_fast_codebase_map ? "yes" : "no"}
|
||||
|
||||
- Project: .planning/PROJECT.md
|
||||
- Requirements: .planning/REQUIREMENTS.md
|
||||
- Roadmap: .planning/ROADMAP.md
|
||||
- State: .planning/STATE.md
|
||||
- Codebase map: {CODEBASE_MAP_SUMMARY_STATUS}
|
||||
|
||||
## Codebase Map
|
||||
|
||||
{if has_codebase_map}
|
||||
Confirmed files:
|
||||
- STACK.md
|
||||
- ARCHITECTURE.md
|
||||
- STRUCTURE.md
|
||||
- CONVENTIONS.md
|
||||
- TESTING.md
|
||||
- INTEGRATIONS.md
|
||||
- CONCERNS.md
|
||||
{else if fast_mode && has_fast_codebase_map}
|
||||
Accepted fast map files:
|
||||
- STACK.md
|
||||
- INTEGRATIONS.md
|
||||
- ARCHITECTURE.md
|
||||
- STRUCTURE.md
|
||||
Context strength: fast/partial-but-accepted codebase map; not all seven map files are present.
|
||||
{else}
|
||||
Present files: {codebase_map_files_present}
|
||||
Missing files: {missing_codebase_map_files}
|
||||
Context strength: weaker because codebase mapping was skipped or is incomplete.
|
||||
{endif}
|
||||
|
||||
## Existing Docs
|
||||
|
||||
Detected planning docs: {doc_candidate_count}
|
||||
## Docs Context
|
||||
- Existing ADR/PRD/SPEC/RFC candidates: {has_docs_candidates ? doc_candidate_count : 0}
|
||||
|
||||
## Recommended Next Step
|
||||
|
||||
/gsd:discuss-phase 1
|
||||
- {next_action.reason}
|
||||
```
|
||||
|
||||
Commit the summary if `commit_docs` is true:
|
||||
If `commit_docs` is true, commit only the summary path from the onboarding root:
|
||||
|
||||
```bash
|
||||
gsd_run --cwd "$ONBOARDING_ROOT" query commit "docs: create onboarding summary" --files .planning/onboarding/SUMMARY.md
|
||||
```
|
||||
|
||||
## 7. Final Status
|
||||
Continue to final status.
|
||||
|
||||
## 4. Final Status
|
||||
|
||||
Print:
|
||||
|
||||
```
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
GSD ► ONBOARDING COMPLETE ✓
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
```text
|
||||
Onboarding status:
|
||||
- PROJECT.md: {project_exists ? "present" : "missing"}
|
||||
- REQUIREMENTS.md: {requirements_exists ? "present" : "missing"}
|
||||
- ROADMAP.md: {roadmap_exists ? "present" : "missing"}
|
||||
- STATE.md: {state_exists ? "present" : "missing"}
|
||||
- Codebase map: {codebase_map_final_status}
|
||||
- Onboarding summary: present
|
||||
|
||||
Created / confirmed / status:
|
||||
- .planning/codebase/ {CODEBASE_MAP_FINAL_STATUS}
|
||||
- .planning/PROJECT.md
|
||||
- .planning/REQUIREMENTS.md {requirements_exists ? "(present)" : "(missing; onboarding incomplete)"}
|
||||
- .planning/ROADMAP.md
|
||||
- .planning/STATE.md
|
||||
- .planning/onboarding/SUMMARY.md
|
||||
|
||||
───────────────────────────────────────────────────────────────
|
||||
|
||||
## ▶ Next Up
|
||||
|
||||
**Discuss Phase 1** — capture implementation decisions before planning.
|
||||
|
||||
`/gsd:discuss-phase 1`
|
||||
|
||||
───────────────────────────────────────────────────────────────
|
||||
|
||||
**Also available:**
|
||||
- `/gsd:map-codebase` — refresh the codebase map after significant changes
|
||||
- `/gsd:ingest-docs --mode merge` — merge new ADR/PRD/SPEC docs into planning
|
||||
- `/gsd:progress` — inspect current workflow state
|
||||
|
||||
───────────────────────────────────────────────────────────────
|
||||
Next recommended command: /gsd:manager
|
||||
```
|
||||
|
||||
</process>
|
||||
|
||||
<success_criteria>
|
||||
- [ ] Existing codebase detected before project initialization
|
||||
- [ ] Missing codebase map routes to `/gsd:map-codebase` or `/gsd:map-codebase --fast`
|
||||
- [ ] Existing planning docs route to `/gsd:ingest-docs`
|
||||
- [ ] Missing project setup routes to `/gsd:new-project`
|
||||
- [ ] Existing `.planning/` files are not overwritten silently
|
||||
- [ ] Text mode stops and waits at numbered-list gates
|
||||
- [ ] `.planning/onboarding/SUMMARY.md` is created only after PROJECT.md exists
|
||||
- [ ] User sees next command
|
||||
</success_criteria>
|
||||
Do not run implementation execution or shipping from onboarding.
|
||||
|
||||
Reference in New Issue
Block a user