Skip to content

docs(readme): trim to principles and cross-link docs - #21

Merged
samson910022 merged 2 commits into
mainfrom
docs/readme-trim-crosslink
Sep 10, 2026
Merged

samson910022 merged 2 commits into
mainfrom
docs/readme-trim-crosslink

Conversation

@samson910022

Copy link
Copy Markdown
Owner

Summary

  • README EN/zh-CN trimmed to feature brief + minimal usage (2 examples: Chat + Responses); 399/407 lines -> ~179/177
  • Full env/config/bridge/allowlist/diagnostics live in docs/configuration.md; examples in docs/api-reference.md
  • Bidirectional nav: Root<->Docker<->GettingStarted, Root<->Development<->CONTRIBUTING, Index<->AI_BOT, guides回连Index/Root
  • Fixes: zh anchor #-快速开始, docs index self-links (bold), docker-compose host-deployments inline-code, zh header Issues + 简体标签
  • Branch cleanup done separately: 16 merged remote branches + 10 local deleted; only main + feat/backend-models-observability remain

Verification

  • typecheck + build green
  • 347 tests pass (22 suites)
  • Phase reviews: P1 double-PASS, P2 fix-loop to PASS, P3 fix-loop to PASS, final 2 PASS + 1 conditional PASS (api-reference health/details tracked gap, repo-wide covered via configuration.md)
  • No secrets in diff; no git-ignored links (host-deployments only inline code)

- 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
@github-actions

github-actions Bot commented Sep 10, 2026 •

Copy link
Copy Markdown

Verdict matrix

  • Roles: gateway_safety, api_compat, docs_config
  • FINAL_VERDICT: APPROVE

Sensitive paths

  • docker-compose.yml

Deterministic pre-checks

  • (none)

gateway_safety

VERDICT: APPROVE

Rationale: Purely documentation-only changes (README trim + cross-links + anchor fixes + docker-compose comment tweak). No source, no config, no auth, no tool, no lifecycle, no retry/timeout, no logging, no CI changes. All safety invariants preserved verbatim; verification in PR body confirms no secrets and green checks.

BLOCKING: (none)

SHOULD_FIX: (none)

NITS: (none)

api_compat

API Compatibility Review

This PR is a docs-only change: README trimming, cross-link navigation, and docker-compose.yml comment wording. No source code (src/, index.ts, test files) is touched.

Checklist evaluation

# Check Result
1 Route error wire shapes preserved ✅ No route/handler code changed
2 Converter thinking/signature handling ✅ No converter code changed
3 Session chaining / TTL / sweep ✅ No session code changed
4 Reasoning mapping thresholds ✅ No reasoning code changed
5 Model alias rules ✅ No alias code changed
6 Collector finish/idle/flushHeaders ✅ No collector code changed
7 resolveMaxRetries / backoff / jitter ✅ No retry code changed
8 New endpoints documented N/A — no new endpoints

Findings

BLOCKING: (none)

SHOULD_FIX:

  1. README.zh-CN.md:9 — The anchor #快速开始 (without emoji) is correct for GitHub's heading-ID generation from ## 快速开始, but the actual heading in the file is ## 🚀 快速开始 which GitHub renders as #-快速开始 (emoji stripped, leading dash). The PR body claims this was fixed, but the link #快速开始 still won't match #-快速开始. Verify the rendered anchor on GitHub and adjust if needed (likely should be #-快速开始 or remove the emoji from the heading).

NITS:

  1. docker-compose.yml:54 — The change from docs/host-deployments.md to `docs/host-deployments.md` (inline code) is fine cosmetically, but the comment still references a file (docs/host-deployments.md) that per the project rules is not committed to the repo. This is pre-existing and not introduced by this PR, so just a note.

  2. README.md:106 / README.zh-CN.md:106 — The trimmed README keeps only Chat Completions and Responses examples. The Messages and Interactions wire-shape notes (no [DONE] for Messages, no [DONE] for Interactions) that were previously inline are now only in docs/api-reference.md. This is fine for brevity but worth confirming those notes survived in the target doc.

  3. README.zh-CN.md:174 — The ## 🙏 致谢 section dropped the English-language acknowledgment paragraph that was present in the old version. The EN README still has it. Minor asymmetry, not a compatibility issue.

Test gaps

None introduced — no code changes, no new test requirements.


VERDICT: APPROVE

Clean docs-only refactor with proper cross-linking. The only item worth a second look is the zh-CN anchor target (should-fix #1), which may produce a broken in-page link depending on GitHub's emoji-stripping behavior.

docs_config

VERDICT: APPROVE

BLOCKING: none

  • No new/changed env in diff; six-way matrix intact.
  • No secrets leaked; Bearer [REDACTED] / [REDACTED] only.
  • docker-compose.yml:54 host-deployments ref is inline-code `docs/host-deployments.md`, not a link — git-ignored file not linked.
  • No wire-shape / route / auth logic touched.

SHOULD_FIX: none

  • docs/docker.md:157 footer is Index + Getting Started only. For full Root<->Docker<->GettingStarted closure, consider adding 🏠 [Main README](../README.md) like docs/getting-started.md:99, docs/development.md:139.
  • docs/README.md:7, docs/README.zh-CN.md:7 self-link bold fix verified. Root README.md / README.zh-CN.md language bars still self-link (out of scope, consistent with prior).

NITS:

  • README.md:22-32, README.zh-CN.md:22-32 trim preserves invariants: 429-only fallback, DISABLE_TOOLS=true default, opt-in web_fetch only when no tools. Removal of external__web_fetch namespace detail is good — internal routing should not be advertised.
  • README.zh-CN.md:9 #-快速开始 -> #快速开始, 語言 -> 语言, + Issues link verified. CONTRIBUTING.md:86, docs/AI_BOT.md:3, docs/api-reference.md:7, docs/configuration.md:13, docs/troubleshooting.md:160 Index<->Root backlinks verified.
  • No npm run lint introduced; CONTRIBUTING.md:88 keeps npm run test:unit, README.md:167 keeps npm test -- --runInBand history.

Matrix gap closure:

  • No env added/renamed/removed. Files that must change to close gap: none. Canonical detail remains in docs/configuration.md (untouched except nav line); .env.example, config.json.example, Dockerfile, docker-compose.yml, index.ts, AGENTS.md require no update in this PR.

FINAL_VERDICT: APPROVE

Session: response_id=a56d61d1-e635-9c3a-8df9-21c4a0f23a23,resp_req_vrtx_011CevXLYzivUEmDBhaVdSoa,chatcmpl-9d33252f-ac5c-4840-94fe-05ca59125472 (chain via previous_response_id, 30min TTL). model=[model] provider=[provider].

- 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
@samson910022
samson910022 merged commit 562c949 into main Sep 10, 2026
5 checks passed
@samson910022
samson910022 deleted the docs/readme-trim-crosslink branch September 10, 2026 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant