Skip to content

docs: 重组文档导航并明确规范职责#20

Merged
yhcedpn merged 2 commits into
mainfrom
doc-update
Jun 14, 2026
Merged

docs: 重组文档导航并明确规范职责#20
yhcedpn merged 2 commits into
mainfrom
doc-update

Conversation

@yhcedpn

@yhcedpn yhcedpn commented Jun 14, 2026

Copy link
Copy Markdown
Owner

目的

统一仓库文档分工,减少 README、Wiki 与规范文件之间的职责重叠,让使用入口、教程入口和行为契约入口更清晰。

变更类型

  • feat
  • fix
  • docs
  • refactor
  • test
  • build
  • breaking change

变更

  1. 将规范文件重命名为更直接的名称,并补充规范文件承载“开发规范和功能行为契约”的说明。
  2. 更新 AGENTS.md,明确 README.md 负责项目介绍、快速开始和文档索引,wiki/ 负责快速开始和算法使用教程。
  3. 精简 README.md,移除过长的安装与示例细节,改为聚焦项目简介、包源信息和文档入口。
  4. 重组 Wiki 导航:
    • 新增 Quick-Start
    • 将各算法页面从 *-Reference 调整为 *-Guide
    • 更新 Home_Sidebar,统一文档入口结构
  5. 删除已不再使用的旧导航页,如 Getting-StartedAlgorithm-Overview

测试

  • 未运行自动化测试。
  • 本次为文档与规范命名/导航调整,未修改运行时代码。

影响

  • 无破坏性运行时影响。
  • 现有文档链接和页面名称发生调整,依赖旧 Wiki 页面名的外部链接可能需要同步更新。

关联 Issue

@yhcedpn yhcedpn self-assigned this Jun 14, 2026
@yhcedpn yhcedpn added the documentation Improvements or additions to documentation label Jun 14, 2026
@yhcedpn yhcedpn merged commit 77ea500 into main Jun 14, 2026
1 check passed
@yhcedpn yhcedpn deleted the doc-update branch June 14, 2026 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant