Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,22 @@ In practice, that means you can start small, branch out when a task gets bigger,

## Documentation

The root README is the quick-start guide. Use the docs folder for deeper detail:
Full user-facing documentation lives in [`docs/documentation/`](docs/documentation/index.md):

| Page | Description |
|---|---|
| [Getting Started](docs/documentation/getting-started.md) | Installation, first run, and initial configuration |
| [Commands](docs/documentation/commands.md) | Complete CLI command and flag reference |
| [Interactive Mode](docs/documentation/interactive-mode.md) | TUI, REPL, slash commands, keyboard shortcuts |
| [Configuration](docs/documentation/configuration.md) | Config files, TOML format, and environment variables |
| [Providers](docs/documentation/providers.md) | LLM provider setup — MiniMax, Anthropic, OpenAI, OpenRouter |
| [Tools](docs/documentation/tools.md) | All agent tools — file ops, search, shell, web, and more |
| [Sessions](docs/documentation/sessions.md) | Session lifecycle, persistence, resume, and management |
| [Permissions](docs/documentation/permissions.md) | Approval system, permission modes, and safe mode |
| [Skills](docs/documentation/skills.md) | Skill discovery, installation, and authoring |
| [Advanced](docs/documentation/advanced.md) | Sub-agents, MCP servers, hooks, orchestration, and IPC |

Internal design docs:

- [Product Requirements](docs/prd.md)
- [Tech Stack](docs/tech-stack.md)
Expand Down
Loading
Loading