Skip to content

docs: 在线文档信息架构重构 + 死代码清理#78

Merged
Agions merged 1 commit into
mainfrom
docs/redesign-ia
Jun 16, 2026
Merged

docs: 在线文档信息架构重构 + 死代码清理#78
Agions merged 1 commit into
mainfrom
docs/redesign-ia

Conversation

@Agions

@Agions Agions commented Jun 16, 2026

Copy link
Copy Markdown
Owner

概述

以资深架构师视角重构在线文档。内容已准确(与重构后代码一致),本次只调整信息架构、导航完整性、死代码与链接健壮性,不改配色/不重写正文。

主要改动

  1. IA 重构(核心):nav 与 sidebar 改为单一来源、五大分类(开始使用 / 生产流程 / 参考 / 设计决策 / 帮助)一一对应。消除原 //guide//ai-models 三套 sidebar 的重复与退化(quick-start 此前出现 3 次、interface 归类不一致、ai-models 是退化单项组)。
  2. ADR 进导航:7 个 ADR 此前无任何导航入口,用户无法发现。新增 adr/index.md 决策总览(表格 + 阅读建议)并把 7 ��� ADR 纳入 sidebar 分组。
  3. 删死代码:11 个自定义 Vue 组件(Badge/Card/Steps/Timeline 等)零引用且未在 theme 注册,全部删除。
  4. 链接健壮性:首页 6 处硬编码 /scene-fab/*.htmlwithBase() 相对链接(base 变更安全);修复 ADR-004 指向不存在文件的死链;移除 ignoreDeadLinks: true 改为强制检查,避免未来断链被掩盖。

验收

npm run docs:build 成功,死链检查通过(已开启强制)。

净变化

14 文件,+119 / −578(主要为删除死组件)。

注:deprecations.md 为开发用弃用清单,按设计不进导航(保留文件供开发参考)。

在线文档 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 成功,死链检查通过
@Agions Agions merged commit 45e7b76 into main Jun 16, 2026
2 checks passed
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