singularity-forge/docs/dev/extending-pi/23-file-reference-documentation.md
Jeremy 872b0adb48 docs: reorganize into user-docs/ and dev/ subdirectories
Split flat docs/ into user-docs/ (guides, config, troubleshooting) and
dev/ (ADRs, architecture, extension guides, proposals). Updated
docs/README.md index to reflect new paths.
2026-04-10 09:25:31 -05:00

24 lines
1.1 KiB
Markdown

# File Reference — Documentation
All paths relative to:
```
/Users/lexchristopherson/.nvm/versions/node/v22.20.0/lib/node_modules/@mariozechner/pi-coding-agent/
```
| File | What It Covers |
|------|---------------|
| `docs/extensions.md` | **Primary reference** — Full extensions API (1,972 lines) |
| `docs/tui.md` | TUI component system — `Component` interface, built-in components, keyboard input, theming, overlay system, performance, patterns |
| `docs/packages.md` | Creating and distributing pi packages (npm, git, local) |
| `docs/session.md` | Session file format, entry types, message types, SessionManager API |
| `docs/compaction.md` | Auto-compaction, branch summarization, custom compaction hooks |
| `docs/rpc.md` | RPC mode protocol for headless/embedded operation |
| `docs/sdk.md` | SDK integrations |
| `docs/custom-provider.md` | Custom model providers, OAuth, streaming APIs |
| `docs/keybindings.md` | Keyboard shortcut format and built-in keybindings |
| `docs/themes.md` | Creating custom themes |
| `docs/settings.md` | Settings configuration |
| `README.md` | Main pi documentation |
---