docs: update English documentation for v1.32.0 release
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Tom Boucher
@@ -427,6 +427,7 @@ The `security.cjs` module scans for known injection patterns (role overrides, in
|
||||
| `/gsd-insert-phase [N]` | Insert urgent work (decimal numbering) | Urgent fix mid-milestone |
|
||||
| `/gsd-remove-phase [N]` | Remove future phase and renumber | Descoping a feature |
|
||||
| `/gsd-list-phase-assumptions [N]` | Preview Claude's intended approach | Before planning, to validate direction |
|
||||
| `/gsd-analyze-dependencies` | Detect phase dependencies for ROADMAP.md | Before `/gsd-manager` when phases have empty `Depends on` |
|
||||
| `/gsd-plan-milestone-gaps` | Create phases for audit gaps | After audit finds missing items |
|
||||
| `/gsd-research-phase [N]` | Deep ecosystem research only | Complex or unfamiliar domain |
|
||||
|
||||
@@ -436,7 +437,8 @@ The `security.cjs` module scans for known injection patterns (role overrides, in
|
||||
|---------|---------|-------------|
|
||||
| `/gsd-map-codebase` | Analyze existing codebase | Before `/gsd-new-project` on existing code |
|
||||
| `/gsd-quick` | Ad-hoc task with GSD guarantees | Bug fixes, small features, config changes |
|
||||
| `/gsd-debug [desc]` | Systematic debugging with persistent state | When something breaks |
|
||||
| `/gsd-autonomous` | Run remaining phases autonomously (`--from N`, `--to N`) | Hands-free multi-phase execution |
|
||||
| `/gsd-debug [desc]` | Systematic debugging with persistent state (`--diagnose` for no-fix mode) | When something breaks |
|
||||
| `/gsd-forensics` | Diagnostic report for workflow failures | When state, artifacts, or git history seem corrupted |
|
||||
| `/gsd-add-todo [desc]` | Capture an idea for later | Think of something during a session |
|
||||
| `/gsd-check-todos` | List pending todos | Review captured ideas |
|
||||
@@ -533,6 +535,7 @@ GSD stores project settings in `.planning/config.json`. Configure during `/gsd-n
|
||||
| `workflow.research_before_questions` | `true`, `false` | `false` | Run research before discussion questions instead of after |
|
||||
| `workflow.discuss_mode` | `standard`, `assumptions` | `standard` | Discussion style: open-ended questions vs. codebase-driven assumptions |
|
||||
| `workflow.skip_discuss` | `true`, `false` | `false` | Skip discuss-phase entirely in autonomous mode; writes minimal CONTEXT.md from ROADMAP phase goal |
|
||||
| `response_language` | language code | (none) | Agent response language for cross-phase consistency (e.g., `"pt"`, `"ko"`, `"ja"`) |
|
||||
|
||||
### Hook Settings
|
||||
|
||||
@@ -705,6 +708,27 @@ Each workspace gets:
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### STATE.md Out of Sync
|
||||
|
||||
If STATE.md shows incorrect phase status or position, use the state consistency commands:
|
||||
|
||||
```bash
|
||||
node gsd-tools.cjs state validate # Detect drift between STATE.md and filesystem
|
||||
node gsd-tools.cjs state sync --verify # Preview what sync would change
|
||||
node gsd-tools.cjs state sync # Reconstruct STATE.md from disk
|
||||
```
|
||||
|
||||
These commands are new in v1.32 and replace manual STATE.md editing.
|
||||
|
||||
### Read-Before-Edit Infinite Retry Loop
|
||||
|
||||
Some non-Claude runtimes (Cline, Augment Code) may enter an infinite retry loop when an agent attempts to edit a file it hasn't read. The `gsd-read-before-edit.js` hook (v1.32) detects this pattern and advises reading the file first. If your runtime doesn't support PreToolUse hooks, add this to your project's `CLAUDE.md`:
|
||||
|
||||
```markdown
|
||||
## Edit Safety Rule
|
||||
Always read a file before editing it. Never call Edit or Write on a file you haven't read in this session.
|
||||
```
|
||||
|
||||
### "Project already initialized"
|
||||
|
||||
You ran `/gsd-new-project` but `.planning/PROJECT.md` already exists. This is a safety check. If you want to start over, delete the `.planning/` directory first.
|
||||
@@ -766,6 +790,10 @@ Set `commit_docs: false` during `/gsd-new-project` or via `/gsd-settings`. Add `
|
||||
|
||||
Since v1.17, the installer backs up locally modified files to `gsd-local-patches/`. Run `/gsd-reapply-patches` to merge your changes back.
|
||||
|
||||
### Cannot Update via npm
|
||||
|
||||
If `npx get-shit-done-cc` fails due to npm outages or network restrictions, see [docs/manual-update.md](manual-update.md) for a step-by-step manual update procedure that works without npm access.
|
||||
|
||||
### Workflow Diagnostics (`/gsd-forensics`)
|
||||
|
||||
When a workflow fails in a way that isn't obvious -- plans reference nonexistent files, execution produces unexpected results, or state seems corrupted -- run `/gsd-forensics` to generate a diagnostic report.
|
||||
@@ -806,7 +834,8 @@ If the installer crashes with `EPERM: operation not permitted, scandir` on Windo
|
||||
| Phase went wrong | `git revert` the phase commits, then re-plan |
|
||||
| Need to change scope | `/gsd-add-phase`, `/gsd-insert-phase`, or `/gsd-remove-phase` |
|
||||
| Milestone audit found gaps | `/gsd-plan-milestone-gaps` |
|
||||
| Something broke | `/gsd-debug "description"` |
|
||||
| Something broke | `/gsd-debug "description"` (add `--diagnose` for analysis without fixes) |
|
||||
| STATE.md out of sync | `state validate` then `state sync` |
|
||||
| Workflow state seems corrupted | `/gsd-forensics` |
|
||||
| Quick targeted fix | `/gsd-quick` |
|
||||
| Plan doesn't match your vision | `/gsd-discuss-phase [N]` then re-plan |
|
||||
|
||||
Reference in New Issue
Block a user