Skip to content

docs: drop stale Phase 1 scaffold copy & realign top entry pages (#167)#192

Merged
g1331 merged 1 commit into
masterfrom
docs/p0-stale-copy-167
May 27, 2026
Merged

docs: drop stale Phase 1 scaffold copy & realign top entry pages (#167)#192
g1331 merged 1 commit into
masterfrom
docs/p0-stale-copy-167

Conversation

@g1331
Copy link
Copy Markdown
Owner

@g1331 g1331 commented May 27, 2026

背景

文档站 34/34 早已合入 master,但访客首屏与 README badge 还在传达「文档没好」的错误信号。本 PR 把这三处与现实矛盾的过时文案修掉。

改动清单

docs/index.md

  • 删除「当前处于 Phase 1 脚手架阶段」「第一批优先撰写 10 篇」整段
  • 替换为「从哪里开始」按读者状态切分的三条路径:
    • A 部署上线(4 篇):overview → quickstart → env-reference → cliproxy-sidecar
    • B 接入第一次调用(5 篇):admin-overview → first-upstream → client-keys → invoke-models → cliproxy-first-time
    • C 理解架构与贡献(4 篇):overview → request-lifecycle → security → contributing
  • 把 34 篇完整清单的引导移到段末,链接保留 issue 作为撰写背景

docs/en/index.md

  • 删除「English documentation is in progress」与「Translation work will follow the Chinese first-batch once the Chinese versions stabilize」这两处会让访客误以为翻译即将完成的表述
  • 改为如实声明:英文版仅占位、中文版是 source of truth,给出阅读中文版 + 浏览器翻译的实操工作流;明确说没有时间表、欢迎单篇翻译 PR

README.md / README_EN.md

  • Docs badge 从 Docs-WIP-orange 改为 Docs-online-3eaf7c(vue 主色),与「34/34 文档已上线」事实对齐

不在本 PR 范围

下列 issue #167 衍生的收尾工作单独处理,避免本次小步改动越界:

  • README.md / README_EN.md 双语主体减负 + 链接到 CPA / circuit-breaker 章节
  • 英文版翻译滚动补齐(docs/en/ 整站正文)
  • docs/cliproxy-deployment.md / docs/circuit-breaker.md 旧长篇与 legacySidebar 的清退决策
  • 自定义域名(CNAME)optional 项

Test plan

  • pnpm docs:build 本地通过
  • pre-commit(prettier / end-of-file / trim trailing whitespace)全过
  • CI: Build VitePress site / Quality / Verify Status 等 12 项 pass

PR #189 合入后 34/34 文档主体均已上线,但访客首先看到的三处入口
仍在传达「文档没好」的错误信号,与现实矛盾。

docs/index.md
- 删除「当前处于 Phase 1 脚手架阶段」「正文按主题分批撰写」「第一批
  优先撰写 10 篇」整段
- 替换为「从哪里开始」按读者所处状态切分的三条路径:
  A 部署上线 / B 接入第一次调用 / C 理解架构与贡献
- 文档主体进度统计放进收尾段,issue 链接保留作为撰写背景

docs/en/index.md
- 删除「English documentation is in progress」「Translation work will
  follow the Chinese first-batch once the Chinese versions stabilize」
  这两处误导性表述
- 改为如实声明:英文版尚无翻译内容,给出阅读中文版 + 浏览器翻译的
  实操工作流;明确说没有英文翻译时间表,欢迎单篇翻译 PR

README.md / README_EN.md
- Docs badge 从 `Docs-WIP-orange` 改为 `Docs-online-3eaf7c`(vue 主
  色),与「文档已上线、34/34 完成」的事实对齐

零代码改动,纯文案;本地 pnpm docs:build 通过。
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