Skip to content

Commit 271d907

Browse files
committed
docs(readme): address PR review findings
- Node footer: Docker Deployment -> Development + Getting Started - Fallback: restore free-limit 429 qualifier (EN/ZH, table + config bullets) - Troubleshooting: restore reasoning.effort requirement - Footers: list items -> blockquote style, align Docs Index pattern
1 parent 39cf689 commit 271d907

4 files changed

Lines changed: 12 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Turn a local [OpenCode](https://opencode.ai) runtime into an OpenAI-, Anthropic-
2323
| 🔁 **Gemini compatible (thin)** | `POST /v1beta/interactions` (alias `POST /v1/interactions`) |
2424
| 🌐 **Server-side web search** | `web_search` with `web_search_call` + `url_citation` |
2525
| 🔑 **Multi-key auth** | `API_KEY` + `OPENCODE_API_KEYS` merge; `Bearer` or `x-api-key`; empty skips auth |
26-
| 🔀 **Fallback proxy** | 429-only `OPENCODE_UPSTREAM_PROXIES` rotation |
26+
| 🔀 **Fallback proxy** | free-limit 429-only `OPENCODE_UPSTREAM_PROXIES` rotation |
2727
| 📡 **Streaming** | SSE for Chat, Responses, Messages, Interactions |
2828
| 🧠 **Reasoning control** | `reasoning_effort` / `reasoning: {"effort": "high"}` |
2929
| 🐳 **Docker deploy** | One-command with auto backend |
@@ -71,7 +71,7 @@ npm run build
7171
npm start
7272
```
7373

74-
> 📖 Full guide: [Docker Deployment](./docs/docker.md)
74+
> 📖 Full guide: [Development](./docs/development.md) · 🚀 [Getting Started](./docs/getting-started.md)
7575
7676
---
7777

@@ -113,7 +113,7 @@ curl -N -X POST http://127.0.0.1:10000/v1/responses \
113113
- Base: `API_KEY`, `OPENCODE_SERVER_PASSWORD`, `OPENCODE_SERVER_URL`, `OPENCODE_PROXY_PORT` (`PORT`).
114114
- Tool safety: `DISABLE_TOOLS=true` default; external `tools` bridged/isolated, built-ins disabled unless allowlisted.
115115
- Observability: `/health/details` and `/metrics` with configurable exposure/auth.
116-
- Timeout & retry: `OPENCODE_PROXY_REQUEST_TIMEOUT_MS`, `OPENCODE_PROXY_RETRY_MAX_RETRIES`; `OPENCODE_UPSTREAM_PROXIES` only on 429.
116+
- Timeout & retry: `OPENCODE_PROXY_REQUEST_TIMEOUT_MS`, `OPENCODE_PROXY_RETRY_MAX_RETRIES`; `OPENCODE_UPSTREAM_PROXIES` only on free-limit 429.
117117

118118
> 📄 Full reference: [Configuration](./docs/configuration.md)
119119
@@ -147,7 +147,7 @@ Formats: `opencode/big-pickle`, `gpt5-nano` (auto-resolved) and `opencode/gpt5-n
147147

148148
## 🔧 Troubleshooting
149149

150-
Hangs: try `OPENCODE_USE_ISOLATED_HOME=false`. Missing model: check `/v1/models`. No reasoning: use Responses API with `stream: true`.
150+
Hangs: try `OPENCODE_USE_ISOLATED_HOME=false`. Missing model: check `/v1/models`. No reasoning: use Responses API with `stream: true` + `reasoning.effort`.
151151

152152
> 📖 Full guide: [Troubleshooting](./docs/troubleshooting.md)
153153

‎README.zh-CN.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
| 🔁 **Gemini 兼容(薄层)** | `POST /v1beta/interactions`(别名 `POST /v1/interactions`) |
2424
| 🌐 **服务端联网搜索** | `web_search`,返回 `web_search_call` + `url_citation` |
2525
| 🔑 **多 Key 认证** | `API_KEY` 与 `OPENCODE_API_KEYS` 合并;`Bearer` 或 `x-api-key`;为空免认证 |
26-
| 🔀 **免费限流 fallback 代理** | 仅 429 时轮换 `OPENCODE_UPSTREAM_PROXIES` |
26+
| 🔀 **免费限流 fallback 代理** | 仅免费限流 429 时轮换 `OPENCODE_UPSTREAM_PROXIES` |
2727
| 📡 **流式输出** | Chat、Responses、Messages、Interactions 全支持 SSE |
2828
| 🧠 **推理控制** | `reasoning_effort` / `reasoning: {"effort": "high"}` |
2929
| 🐳 **Docker 部署** | 一键部署,自动启动后端 |
@@ -71,7 +71,7 @@ npm run build
7171
npm start
7272
```
7373

74-
> 📖 完整指南:[Docker 部署](./docs/docker.md)
74+
> 📖 完整指南:[开发指南](./docs/development.md) · 🚀 [快速开始](./docs/getting-started.md)
7575
7676
---
7777

@@ -113,7 +113,7 @@ curl -N -X POST http://127.0.0.1:10000/v1/responses \
113113
- 基础:`API_KEY`、`OPENCODE_SERVER_PASSWORD`、`OPENCODE_SERVER_URL`、`OPENCODE_PROXY_PORT`(`PORT`)。
114114
- 工具安全:默认 `DISABLE_TOOLS=true`;外部 `tools` 经桥接隔离,内置工具默认禁用,按需 allowlist 放行。
115115
- 可观测性:`/health/details` 与 `/metrics` 均可配置开关与鉴权。
116-
- 超时与重试:`OPENCODE_PROXY_REQUEST_TIMEOUT_MS`、`OPENCODE_PROXY_RETRY_MAX_RETRIES`;仅 429 时启用 `OPENCODE_UPSTREAM_PROXIES`。
116+
- 超时与重试:`OPENCODE_PROXY_REQUEST_TIMEOUT_MS`、`OPENCODE_PROXY_RETRY_MAX_RETRIES`;仅免费限流 429 时启用 `OPENCODE_UPSTREAM_PROXIES`。
117117

118118
> 📄 完整配置参考:[配置详解](./docs/configuration.md)
119119
@@ -147,7 +147,7 @@ curl -N -X POST http://127.0.0.1:10000/v1/responses \
147147

148148
## 🔧 故障排查
149149

150-
卡住:试 `OPENCODE_USE_ISOLATED_HOME=false`。模型缺失:检查 `/v1/models`。无推理:用 `stream: true` 的 Responses API。
150+
卡住:试 `OPENCODE_USE_ISOLATED_HOME=false`。模型缺失:检查 `/v1/models`。无推理:用 `stream: true` + `reasoning.effort` 的 Responses API。
151151

152152
> 📖 完整指南:[故障排查](./docs/troubleshooting.md)
153153

‎docs/getting-started.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,5 @@ curl -N -X POST http://127.0.0.1:10000/v1/responses \
9696

9797
- ⚙️ 查看 [Configuration](./configuration.md) 了解更多配置选项
9898
- 🐳 查看 [Docker Deployment](./docker.md) 了解 Docker 部署详情
99-
- 📖 回 [Docs Index](./README.md)
99+
100+
> 📖 [Docs Index](./README.md) | 🏠 [Main README](../README.md)

‎docs/troubleshooting.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,4 +157,5 @@ OPENCODE_PROXY_DEBUG=true
157157
## 🆘 获取帮助
158158

159159
- 🐛 [GitHub Issues](https://github.com/samson910022/OpenCode2API/issues)
160-
- 📖 [Docs Index](./README.md) | 🏠 [Main README](../README.md)
160+
161+
> 📖 [Docs Index](./README.md) | 🏠 [Main README](../README.md)

0 commit comments

Comments
 (0)