18a0abbfe3
Update README and docs/ to cover new features and changes in v2.20.0: - commands.md: Added /gsd quick, /gsd mode, /gsd help, /gsd skill-health, /gsd hooks, /gsd run-hook, gsd --debug flag. Reorganized into Session Commands, Configuration & Diagnostics, Git, and Session Management. - skills.md: Added Skill Lifecycle Management section covering telemetry, health dashboard (/gsd skill-health), staleness detection, and heal-skill post-unit analysis. - remote-questions.md: Added Telegram as a third channel alongside Slack and Discord, with setup instructions and bot requirements. - configuration.md: Added skill_staleness_days preference. - README.md: Added skill_staleness_days to key settings table, new Agent Instructions section, and Debug Mode section. |
||
|---|---|---|
| .. | ||
| building-coding-agents | ||
| context-and-hooks | ||
| extending-pi | ||
| pi-ui-tui | ||
| what-is-pi | ||
| ADR-001-branchless-worktree-architecture.md | ||
| agent-knowledge-index.md | ||
| architecture.md | ||
| auto-mode.md | ||
| captures-triage.md | ||
| commands.md | ||
| configuration.md | ||
| cost-management.md | ||
| dynamic-model-routing.md | ||
| getting-started.md | ||
| git-strategy.md | ||
| migration.md | ||
| PRD-branchless-worktree-architecture.md | ||
| README.md | ||
| remote-questions.md | ||
| skills.md | ||
| token-optimization.md | ||
| troubleshooting.md | ||
| visualizer.md | ||
| working-in-teams.md | ||
GSD Documentation
Welcome to the GSD documentation. This covers everything from getting started to advanced configuration, auto-mode internals, and extending GSD with the Pi SDK.
User Documentation
| Guide | Description |
|---|---|
| Getting Started | Installation, first run, and basic usage |
| Auto Mode | How autonomous execution works — the state machine, crash recovery, and steering |
| Commands Reference | All commands, keyboard shortcuts, and CLI flags |
| Remote Questions | Discord and Slack integration for headless auto-mode |
| Configuration | Preferences, model selection, git settings, and token profiles |
| Token Optimization | Token profiles, context compression, complexity routing, and adaptive learning (v2.17) |
| Dynamic Model Routing | Complexity-based model selection, cost tables, escalation, and budget pressure (v2.19) |
| Captures & Triage | Fire-and-forget thought capture during auto-mode with automated triage (v2.19) |
| Workflow Visualizer | Interactive TUI overlay for progress, dependencies, metrics, and timeline (v2.19) |
| Cost Management | Budget ceilings, cost tracking, projections, and enforcement modes |
| Git Strategy | Worktree isolation, branching model, and merge behavior |
| Working in Teams | Unique milestone IDs, .gitignore setup, and shared planning artifacts |
| Skills | Bundled skills, skill discovery, and custom skill authoring |
| Migration from v1 | Migrating .planning directories from the original GSD |
| Troubleshooting | Common issues, /gsd doctor, and recovery procedures |
Architecture & Internals
| Guide | Description |
|---|---|
| Architecture Overview | System design, extension model, state-on-disk, and dispatch pipeline |
| Native Engine | Rust N-API modules for performance-critical operations |
| ADR-001: Branchless Worktree Architecture | Decision record for the v2.14 git architecture |
Pi SDK Documentation
These guides cover the underlying Pi SDK that GSD is built on. Useful if you want to extend GSD or build your own agent application.
| Guide | Description |
|---|---|
| What is Pi | Core concepts — modes, agent loop, sessions, tools, providers |
| Extending Pi | Building extensions — tools, commands, UI, events, state |
| Context & Hooks | Context pipeline, hook reference, inter-extension communication |
| Pi UI / TUI | Terminal UI components, theming, keyboard input, rendering |
Research
| Guide | Description |
|---|---|
| Building Coding Agents | Research notes on agent design — decomposition, context engineering, cost/quality tradeoffs |