docs(site): 旧长篇正名为「深度参考」并修正文档计数口径 (#167)#194
Merged
Merged
Conversation
核实发现 docs/cliproxy-deployment.md 与 docs/circuit-breaker.md 被新文档 内链引用 8~11 处,且含新文档未覆盖的独有内容(外部 CLIProxyAPI 部署步骤、 卷备份迁移命令、bind mount 变体、熔断 force-open/close 响应体结构、UI 三色 徽章语义、两类故障排查、最佳实践),并非待清退遗留,而是文档体系有意分层 的深度参考。 - config.ts: legacySidebar → referenceSidebar;分组「现有长篇」→「深度参考」; 条目去掉「旧版长篇」后缀改为「详解」,使命名与真实角色一致 - docs/index.md: 「部署 10 / 使用 13 / 架构 11 共 34 篇」精确计数改为按类 组织 + 含 2 篇深度参考的表述,消除未来增删文档的口径漂移 - docs/en/index.md: 同步去掉「34 documents」硬编码 撤销 issue #167 收尾清单中「旧长篇 + legacySidebar 清退」一项——该判断建立 在「旧长篇是待废弃遗留」的错误前提上,源于未核实引用关系。
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #194 +/- ##
=======================================
Coverage 74.09% 74.09%
=======================================
Files 147 147
Lines 11115 11115
Branches 3847 3847
=======================================
Hits 8236 8236
Misses 1677 1677
Partials 1202 1202
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
背景
issue #167 收尾过程中,原计划清退
docs/根目录两个旧长篇(cliproxy-deployment.md、circuit-breaker.md)。落地前用对抗性覆盖验证 + 引用核查,发现该计划的前提是错误的。核实结论
两个旧长篇都不是待清退遗留,而是文档体系有意分层的深度参考:
cliproxy-deployment.mdcircuit-breaker.md新文档大量以「详见现有长篇
docs/xxx.md」指回旧长篇(例如circuit-breaker-config.md开篇即写「状态机本身的转移规则、与 failover 的协同详见现有长篇docs/circuit-breaker.md;本页只补全实际配置层面的三块内容」)。删除任一篇会同时破坏 8~11 处内链并丢失实质内容。由此撤销 issue #167 收尾清单(
#issuecomment-4554968662)中「旧长篇 + legacySidebar 清退」一项——该判断建立在未核实引用关系的错误前提上。改动
保留两篇旧长篇,仅修正命名与计数口径,使其与真实角色一致:
docs/.vitepress/config.tslegacySidebar→referenceSidebar;侧栏分组「现有长篇」→「深度参考」;条目去掉「(旧版长篇)」后缀,改为「CLIProxyAPI 部署详解」「熔断器与失败转移详解」docs/index.mddocs/en/index.md3 files changed, 6 insertions(+), 6 deletions(-),纯文案与命名,无逻辑改动。校验
pnpm docs:build通过(build complete in 13.73s),sidebar 命名修改未破坏构建,无新增死链报错Test plan
Build VitePress site通过Related
issue #167 文档体系收尾。前序:#189(文档站本体)、#192(P0 stale copy)、#193(README 减负)。