docs

Documentation Map

This docs site is organized by onboarding guides, API reference, and audience-specific docsets.

Canonical Documents

For quick reference, start with these key documents:

Document	Description
CHANGELOG.md	Version history and change log
WORKLOG.md	Active work tracking
PRD.md	Product requirements
SPEC.md	Technical architecture

Guides

• Getting Started
• Install
• Provider Usage
• Provider Quickstarts
• Provider Catalog
• Provider Operations
• ARM64 Docker Provider Quickstart
• Routing and Models
• Troubleshooting

API Reference

• API Index
• OpenAI-Compatible API
• Management API
• Operations API

Feature Guides

• Feature Guide Index
• Architecture
• Authentication
• Security
• Operations
• Providers

Audience Docsets

• Docsets Index
• Developer (Internal)
• Developer (External)
• Technical User
• Agent Operator

Planning and Boards

• Planning Index
• Board Workflow
• 2000-Item Execution Board
• GitHub Project Import CSV

Canonical Project Docs

• Root README
• Contributing
• Security Policy

Information Architecture Baseline

The docs structure is intentionally provider-first and mirrors the proven pattern from upstream CLIProxyAPI docs: install -> config/providers -> routing -> operations -> API.

Baseline references:

• https://github.com/router-for-me/CLIProxyAPI
• https://github.com/router-for-me/CLIProxyAPI/tree/main/docs