Language: English | 简体中文 (per-guide Chinese versions, see Translation status below)
🏠 Main README | 简体中文 README | 🐛 Issues
Welcome to the OpenCode2API documentation.
| Section | Description |
|---|---|
| 📖 Getting Started | Quick start guide |
| ⚙️ Configuration | Env vars + config.json reference |
| 🔌 API Reference | Endpoints, auth, streaming, errors |
| 🐳 Docker Deployment | Compose + docker run + multi-arch |
| 🔧 Troubleshooting | FAQ + debug mode |
| 💻 Development | Build + test + layout |
| 🏗️ Architecture | Runtime shape + extension points (incl. §5 N×N translator registry) |
| 🤖 AI Bot | GitHub AI review/scan/fix bot (gateway + CPA, sticky markers, draft-PR only) |
| 📄 Main README | English canonical entrypoint |
| 📄 README (简体中文) | Simplified Chinese mirror of the main README |
Detailed endpoint diagnostics live with the configuration guide for now: /health/details and /metrics are specified in Configuration and summarized in the Main README.
Docs are migrating to English-first: the root README.md is the English canonical homepage and README.zh-CN.md is its Simplified Chinese mirror. The per-guide files below remain Simplified Chinese for now; their English canonical versions are tracked as follow-ups and must fix the naming drifts first (env OPENCODE_* vs file short keys, see docs/configuration.md).
| Guide | Current language | English version |
|---|---|---|
| Getting Started | 简体中文 | tracked |
| Configuration | 简体中文 | tracked (canonical env names documented; see AGENTS.md §4) |
| API Reference | 简体中文 + EN examples | tracked (needs English canonical + dedicated /health/details + /metrics sections, currently in Configuration) |
| Docker Deployment | 简体中文 | tracked |
| Troubleshooting | 简体中文 | tracked (smallest, do first) |
| Development | 简体中文 | tracked (dedupe with CONTRIBUTING.md) |
| Architecture | English | canonical (N×N registry §5) |
| AI Bot | English | canonical |
Note:
docs/host-deployments.mdandcustom-bin/are local-only (git-ignored via.gitignore/.git/info/exclude, never committed). They are intentionally absent from this index.