| docs: 重构 README 与中文文档目录结构（docs/zh） Co-authored-by: Vossera<galaxygit88@gmail.com> # message auto-generated for no-merge-commit merge: !46 merge feature-README into master docs: 重构 README 与中文文档目录结构（docs/zh） Created-by: gcw_DJmvhaNw Commit-by: Vossera Merged-by: ascend-robot Description: ## Summary 本次 PR 重构项目对外文档入口，将 README 精简为「项目首页 + 快速上手」，并把中文正文统一迁移到 docs/zh/ 分层目录，便于后续维护与 Read the Docs 构建。 主要变更： - **README.md**：按「简介 → 功能介绍 → 快速入门 → 安装/使用指南 → 典型案例 → 扩展参考」重新组织；补充 PyPI / Python / 文档 / 社区等徽章；Agent 表格补齐 **Icarus**；图片与文档链接统一指向 docs/zh/。 - **文档目录重组**：原 docs/agents/、docs/*-guide.md 等中文内容迁移至： - docs/zh/quick_start/（新增《入门安装指南》《快速入门指导》） - docs/zh/agent_guide/（Hermes / Accuracy / Zephyr / Minos / Icarus） - docs/zh/user_guide/（FAQ、配置与扩展、上下文压缩等） - docs/zh/developer_guide/（编译与打包、版本兼容、架构概览等） - docs/zh/images/、docs/zh/example/（静态资源随文档迁移） - docs/zh/legal/（LICENSE、SECURITY 中文入口） - **docs/index.md**：改为轻量入口页，通过 toctree 指向 docs/zh/index 与 docs/legal/。 - **docs/conf.py**：构建时复制 zh/images、zh/example 及 legal/LICENSE；注册 mermaid lexer 以支持相关代码块渲染。 ## 变更详情 ### README | 区域 | 说明 | |------|------| | 顶部 | 增加 PyPI、Python 3.11+、快速入门、配置文档、昇腾社区、Issues 等徽章 | | 简介 / 功能介绍 | 提炼项目定位；Agent 能力表合并为「形象 + 名称 + 领域 + 核心能力」 | | 快速入门 | 压缩安装与 LLM 配置示例，详细说明下沉到 docs/zh/quick_start/ | | 使用指南 | 保留 slash 命令与快捷键速查表 | | 导航链接 | 安装、配置、Agent 说明、FAQ、架构等链接全部改为 docs/zh/... 路径 | ### 文档站点（Sphinx / Read the Docs） - docs/zh/index.md 作为中文文档首页，按四类组织 toctree： - 快速入门 - Agent 指南 - 用户指南 - 开发指南 - 根 docs/index.md 仅保留中英文档与法律声明入口，避免与 README 重复维护大段正文。 ### CI - 移除 .github/workflows/build-wheel.yml（原 wheel 构建 workflow）。若仍需自动化出包，请在合并前确认是否由其他流水线承接。 ## 动机 - README 与 docs/index.md 此前内容高度重复，维护成本高且容易不一致。 - 中文文档缺少清晰分层，新用户难以按「安装 → 上手 → Agent → 开发」路径阅读。 - 为后续多语言文档扩展预留 docs/zh/ 目录空间。 ## 关联信息 - Base branch: master (158e40b) - Head branch: feature-README - Commit: 6b2b1de0ccc11421582ebfda98f18856441778aa See merge request: Ascend/msagent!46 | 25 天前 |
