doc: Add documentation index
This commit is contained in:
125
packages/coding-agent/docs/docs.json
Normal file
125
packages/coding-agent/docs/docs.json
Normal file
@@ -0,0 +1,125 @@
|
||||
{
|
||||
"navigation": [
|
||||
{
|
||||
"title": "Start here",
|
||||
"items": [
|
||||
{
|
||||
"title": "Overview",
|
||||
"path": "index.md"
|
||||
},
|
||||
{
|
||||
"title": "Providers",
|
||||
"path": "providers.md"
|
||||
},
|
||||
{
|
||||
"title": "Settings",
|
||||
"path": "settings.md"
|
||||
},
|
||||
{
|
||||
"title": "Keybindings",
|
||||
"path": "keybindings.md"
|
||||
},
|
||||
{
|
||||
"title": "Sessions",
|
||||
"path": "session.md"
|
||||
},
|
||||
{
|
||||
"title": "Session Tree",
|
||||
"path": "tree.md"
|
||||
},
|
||||
{
|
||||
"title": "Compaction",
|
||||
"path": "compaction.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Customization",
|
||||
"items": [
|
||||
{
|
||||
"title": "Extensions",
|
||||
"path": "extensions.md"
|
||||
},
|
||||
{
|
||||
"title": "Skills",
|
||||
"path": "skills.md"
|
||||
},
|
||||
{
|
||||
"title": "Prompt Templates",
|
||||
"path": "prompt-templates.md"
|
||||
},
|
||||
{
|
||||
"title": "Themes",
|
||||
"path": "themes.md"
|
||||
},
|
||||
{
|
||||
"title": "Pi Packages",
|
||||
"path": "packages.md"
|
||||
},
|
||||
{
|
||||
"title": "Custom Models",
|
||||
"path": "models.md"
|
||||
},
|
||||
{
|
||||
"title": "Custom Providers",
|
||||
"path": "custom-provider.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Programmatic Usage",
|
||||
"items": [
|
||||
{
|
||||
"title": "SDK",
|
||||
"path": "sdk.md"
|
||||
},
|
||||
{
|
||||
"title": "RPC Mode",
|
||||
"path": "rpc.md"
|
||||
},
|
||||
{
|
||||
"title": "JSON Event Stream Mode",
|
||||
"path": "json.md"
|
||||
},
|
||||
{
|
||||
"title": "TUI Components",
|
||||
"path": "tui.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Platform Setup",
|
||||
"items": [
|
||||
{
|
||||
"title": "Windows",
|
||||
"path": "windows.md"
|
||||
},
|
||||
{
|
||||
"title": "Termux on Android",
|
||||
"path": "termux.md"
|
||||
},
|
||||
{
|
||||
"title": "tmux",
|
||||
"path": "tmux.md"
|
||||
},
|
||||
{
|
||||
"title": "Terminal Setup",
|
||||
"path": "terminal-setup.md"
|
||||
},
|
||||
{
|
||||
"title": "Shell Aliases",
|
||||
"path": "shell-aliases.md"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Development",
|
||||
"items": [
|
||||
{
|
||||
"title": "Development",
|
||||
"path": "development.md"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
57
packages/coding-agent/docs/index.md
Normal file
57
packages/coding-agent/docs/index.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Pi Documentation
|
||||
|
||||
Pi is a minimal terminal coding harness. It is designed to stay small at the core while being extended through TypeScript extensions, skills, prompt templates, themes, and pi packages.
|
||||
|
||||
## Quick start
|
||||
|
||||
Install pi with npm:
|
||||
|
||||
```bash
|
||||
npm install -g @mariozechner/pi-coding-agent
|
||||
```
|
||||
|
||||
And run it:
|
||||
|
||||
```bash
|
||||
pi
|
||||
```
|
||||
|
||||
Authenticate with `/login` for subscription providers, or set an API key such as `ANTHROPIC_API_KEY` before starting pi.
|
||||
|
||||
## Start here
|
||||
|
||||
- [Providers](providers.md) - subscription and API-key setup for built-in providers.
|
||||
- [Settings](settings.md) - global and project settings.
|
||||
- [Keybindings](keybindings.md) - default shortcuts and custom keybindings.
|
||||
- [Sessions](session.md) - session storage format and session files.
|
||||
- [Session tree](tree.md) - branching and navigating previous turns.
|
||||
- [Compaction](compaction.md) - context compaction and branch summarization.
|
||||
|
||||
## Customization
|
||||
|
||||
- [Extensions](extensions.md) - TypeScript modules for tools, commands, events, and custom UI.
|
||||
- [Skills](skills.md) - Agent Skills for reusable on-demand capabilities.
|
||||
- [Prompt templates](prompt-templates.md) - reusable prompts that expand from slash commands.
|
||||
- [Themes](themes.md) - built-in and custom terminal themes.
|
||||
- [Pi packages](packages.md) - bundle and share extensions, skills, prompts, and themes.
|
||||
- [Custom models](models.md) - add model entries for supported provider APIs.
|
||||
- [Custom providers](custom-provider.md) - implement custom APIs and OAuth flows.
|
||||
|
||||
## Programmatic usage
|
||||
|
||||
- [SDK](sdk.md) - embed pi in Node.js applications.
|
||||
- [RPC mode](rpc.md) - integrate over stdin/stdout JSONL.
|
||||
- [JSON event stream mode](json.md) - print mode with structured events.
|
||||
- [TUI components](tui.md) - build custom terminal UI for extensions.
|
||||
|
||||
## Platform setup
|
||||
|
||||
- [Windows](windows.md)
|
||||
- [Termux on Android](termux.md)
|
||||
- [tmux](tmux.md)
|
||||
- [Terminal setup](terminal-setup.md)
|
||||
- [Shell aliases](shell-aliases.md)
|
||||
|
||||
## Development
|
||||
|
||||
- [Development](development.md) - local setup, project structure, and debugging.
|
||||
Reference in New Issue
Block a user