Skip to content

Commit 562c949

Browse files
authored
docs(readme): trim to principles and cross-link docs (#21)
* docs(readme): trim to principles and cross-link docs - README EN/zh-CN trimmed to feature brief + minimal usage (2 examples) - Full env/config/bridge/allowlist details live in docs/configuration.md - Add bidirectional nav: Root<->Docker<->GettingStarted, Root<->Development<->CONTRIBUTING, Index<->AI_BOT - Fix zh anchor, docs index self-links, docker-compose inline-code ref * 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 --------- Co-authored-by: samson910022 <samson910022@users.noreply.github.com>
1 parent eba42a1 commit 562c949

13 files changed

Lines changed: 88 additions & 514 deletions

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ npm run dev
8383
npm start
8484
```
8585

86+
See also [Development guide](./docs/development.md) and [Main README](./README.md).
87+
8688
## Testing
8789

8890
- Unit tests: `npm run test:unit`

‎README.md‎

Lines changed: 30 additions & 248 deletions
Large diffs are not rendered by default.

‎README.zh-CN.md‎

Lines changed: 34 additions & 262 deletions
Large diffs are not rendered by default.

‎docker-compose.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ services:
5151
- opencode-config:/home/node/.config/opencode
5252
restart: unless-stopped
5353
# Guard small (1GB) hosts: cap memory/CPU so one slow request cannot wedge
54-
# the whole machine (see docs/host-deployments.md §9). Raw `docker run`
54+
# the whole machine (see `docs/host-deployments.md` §9). Raw `docker run`
5555
# hosts should pass the equivalents: --memory=768m --memory-reservation=256m
5656
# --cpus=1.5 --pids-limit=256.
5757
mem_limit: 768m

‎docs/AI_BOT.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# AI Bot (GitHub Actions)
22

3+
> 📖 [Docs Index](./README.md) | 🏠 [Main README](../README.md)
4+
35
In-repo advisory bot for OpenCode2API: issue investigation, multi-agent PR
46
review, PR explanations, scheduled repo scans with auto-issue, and fix-plan
57
proposals with opt-in draft PRs.

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src="https://img.shields.io/badge/version-1.6.0-blue" alt="Version">
55
</p>
66

7-
> **Language:** [English](./README.md) | [简体中文](./README.zh-CN.md) *(per-guide Chinese versions, see Translation status below)*
7+
> **Language:** **English** | [简体中文](./README.zh-CN.md) *(per-guide Chinese versions, see Translation status below)*
88
>
99
> 🏠 [Main README](../README.md) | [简体中文 README](../README.zh-CN.md) | 🐛 [Issues](https://github.com/samson910022/OpenCode2API/issues)
1010

‎docs/README.zh-CN.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
<img src="https://img.shields.io/badge/version-1.6.0-blue" alt="Version">
55
</p>
66

7-
> **語言:** [English](./README.md) | [简体中文](./README.zh-CN.md)
7+
> **语言:** [English](./README.md) | **简体中文**
88
>
9-
> 🏠 [主 README(English)](../README.md) | [主 README(简体中文)](../README.zh-CN.md)
9+
> 🏠 [主 README(English)](../README.md) | [主 README(简体中文)](../README.zh-CN.md) | 🐛 [Issues](https://github.com/samson910022/OpenCode2API/issues)
1010
>
1111
> 欢迎查看 OpenCode2API 文档
1212

‎docs/api-reference.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
<img src="https://img.shields.io/badge/version-1.6.0-blue" alt="Version">
55
</p>
66

7+
> 📖 [Docs Index](./README.md) | 🏠 [Main README](../README.md)
8+
79
---
810

911
## 📋 基础信息

‎docs/configuration.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
> 配置优先级:**环境变量 > config.json > 默认值**
1212
13+
> 📖 [Docs Index](./README.md) | 🏠 [Main README](../README.md)
14+
1315
---
1416

1517
## 🔧 环境变量

‎docs/development.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,7 @@ OpenCode2API/
136136
## 📄 许可证
137137

138138
MIT License - 详见 [LICENSE](../LICENSE.md)
139+
140+
---
141+
142+
> 📖 [Docs Index](./README.md) | 🏠 [Main README](../README.md) | 🤝 [CONTRIBUTING](../CONTRIBUTING.md)

0 commit comments

Comments
 (0)