singularity-forge/docs
Flux Labs 6998ef2ae4 docs: comprehensive update to preferences reference and configuration guide (#614)
Update both docs/configuration.md (user-facing) and
src/resources/extensions/gsd/docs/preferences-reference.md (internal)
with complete coverage of all GSD preferences:

- Add /gsd prefs subcommands table (global, project, status, wizard, setup)
- Document token_profile (budget/balanced/quality) and phases settings
- Document context_pause_threshold field
- Document remote_questions configuration (Slack/Discord)
- Document git.merge_strategy (squash/merge) and git.isolation (worktree/branch)
- Expand post_unit_hooks with missing agent field
- Expand pre_dispatch_hooks with skip_if, unit_type, model fields
  and action validation rules
- Add known unit types list for hook before/after arrays
- Add examples for pre-dispatch hooks (modify/skip/replace)
- Add examples for token profile, phases, and remote questions
- Update models to show all 6 phases (research, planning, execution,
  execution_simple, completion, subagent)
- Add full example combining all major settings
2026-03-16 07:09:50 -06:00
..
building-coding-agents docs: add extension docs 2026-03-11 00:54:01 -06:00
context-and-hooks docs: add extension docs 2026-03-11 00:54:01 -06:00
extending-pi docs: add extension docs 2026-03-11 00:54:01 -06:00
pi-ui-tui docs: add extension docs 2026-03-11 00:54:01 -06:00
what-is-pi docs: add extension docs 2026-03-11 00:54:01 -06:00
ADR-001-branchless-worktree-architecture.md refactor(git): branchless worktree architecture (#506) 2026-03-15 13:21:58 -06:00
agent-knowledge-index.md docs: add extension docs 2026-03-11 00:54:01 -06:00
architecture.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
auto-mode.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
commands.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
configuration.md docs: comprehensive update to preferences reference and configuration guide (#614) 2026-03-16 07:09:50 -06:00
cost-management.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
getting-started.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
git-strategy.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
migration.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
PRD-branchless-worktree-architecture.md refactor(git): branchless worktree architecture (#506) 2026-03-15 13:21:58 -06:00
README.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
skills.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
token-optimization.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
troubleshooting.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00
working-in-teams.md docs: add comprehensive documentation set and update README (#605) 2026-03-16 06:21:43 -06:00

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
Configuration Preferences, model selection, git settings, and token profiles
Token Optimization Token profiles, context compression, complexity routing, and adaptive learning (v2.17)
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