Skip to content

Commit e627a93

Browse files
committed
restructure: move docs to docs/, rewrite README in English
- Move all .md documentation into docs/ directory - Rewrite README.md with English documentation covering: - All 22 missing source stubs added - Source code fixes (useEffectEvent, version check, auth, sandbox-runtime) - Bun compatibility shims (macro, bun-bundle) - 28 missing npm dependencies - Build and run instructions - Remove dist/ from tracking (users compile themselves)
1 parent 04312fd commit e627a93

11 files changed

Lines changed: 574 additions & 211 deletions

README.md

Lines changed: 124 additions & 209 deletions
Large diffs are not rendered by default.

docs/API-CONFIG.md

Lines changed: 439 additions & 0 deletions
Large diffs are not rendered by default.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

BUILD.md renamed to docs/BUILD.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,9 +319,17 @@ bun dist/bundle.js mcp list
319319

320320
---
321321

322-
## 7. 架构文档
322+
## 7. 文档索引
323323

324-
项目包含 7 份架构分析文档:
324+
### 7.1 API 配置
325+
326+
完整的 API 配置指南(环境变量、认证方式、多云后端、代理、mTLS):
327+
328+
**[API-CONFIG.md](./API-CONFIG.md)**
329+
330+
### 7.2 架构文档
331+
332+
项目包含 8 份架构分析文档:
325333

326334
| 文档 | 大小 | 内容 |
327335
|------|------|------|
@@ -333,6 +341,7 @@ bun dist/bundle.js mcp list
333341
| `ARCHITECTURE-UTILS.md` | 12KB | 290+ 工具文件 |
334342
| `ARCHITECTURE-BRIDGE-REMOTE.md` | 12KB | Bridge/Remote/Coordinator |
335343
| `REFACTORING-ASSESSMENT.md` | 12KB | 重构可行性评估 |
344+
| **`API-CONFIG.md`** | **10KB** | **API 配置完整参考** |
336345

337346
---
338347

0 commit comments

Comments
 (0)