docs: 在线文档信息架构重构 + 死代码清理#78
Merged
Merged
Conversation
在线文档 IA 重构 + 清理(内容已准确,仅调整结构/导航/链接): - config.ts: nav 与 sidebar 改为单一来源、五大分类一一对应,消除 /、/guide/、/ai-models 三套 sidebar 的重复与退化(quick-start 原出现 3 次) - ADR 入导航: 新增 adr/index.md 决策总览 + 7 条 ADR 进 sidebar 分组 (此前 7 个 ADR 无任何导航入口,用户无法发现) - 删除 11 个未使用且未注册的自定义 Vue 组件(Badge/Card/Steps/Timeline 等死代码) - index.md 首页卡片 6 处硬编码 /scene-fab/*.html → withBase 相对链接(base 变更安全) - 修复 adr/004 指向不存在文件的死链;移除 ignoreDeadLinks(改为强制检查, 避免未来断链被掩盖) 验收: npm run docs:build 成功,死链检查通过
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.
概述
以资深架构师视角重构在线文档。内容已准确(与重构后代码一致),本次只调整信息架构、导航完整性、死代码与链接健壮性,不改配色/不重写正文。
主要改动
/、/guide/、/ai-models三套 sidebar 的重复与退化(quick-start 此前出现 3 次、interface 归类不一致、ai-models 是退化单项组)。adr/index.md决策总览(表格 + 阅读建议)并把 7 ��� ADR 纳入 sidebar 分组。/scene-fab/*.html→withBase()相对链接(base 变更安全);修复 ADR-004 指向不存在文件的死链;移除ignoreDeadLinks: true改为强制检查,避免未来断链被掩盖。验收
npm run docs:build成功,死链检查通过(已开启强制)。净变化
14 文件,+119 / −578(主要为删除死组件)。