已合并
[Doc]优化资料文档：FAQ分类索引重构与README易用性提升 #851
LeeQT创建于 17 天前
[Doc]优化资料文档：FAQ分类索引重构与README易用性提升 #851
已合并
Pull Request已成功合入, 合并人@ascend-robot
（感谢 LeeQT 的贡献）
atomgit-bot
17 天前 评论：
17 天前 评论：
变更摘要
本 PR 为纯文档与配置变更（无功能逻辑改动），主要提升 msModelSlim 资料文档的易用性与可维护性：将 FAQ 重构为「统一索引 + 分类子文档」结构并补充 AI 可读元数据，优化 README.md 的业务流程引导，统一文档模板与提示样式；同时优化 .pre-commit-config.yaml 中 gitleaks 本地二进制扫描 hook 的查找逻辑。
主要改动
- gitleaks hook 查找逻辑优化：
.pre-commit-config.yaml中gitleaks-offline-scanhook 的entry改为依次探测./gitleaks.exe、./gitleaks及 PATH 中的gitleaks，均未找到时输出[gitleaks] binary not found提示并以退出码 1 结束，避免误用不存在的二进制；同时增加--staged参数，扫描范围聚焦于暂存区内容。 - FAQ 重构为统一索引 + 分类子文档：
docs/support下新增统一分类索引faq.md，并拆分为安装依赖、运行资源、硬件兼容、精度调优·预留、部署推理·预留、告警提示等分类子文档，各子文档头部新增title/description/keywordsAI 可读元数据，便于 AI 检索并降低 token 开销。 README.md易用性提升：「功能介绍」章节重构为「使用指南」，按业务流程对应工具/功能并给出文档链接，各章节改为引导式描述 + 直达链接，并补充 pip 安装示例。docs/index.md核心优势章节结构化：将核心优势改为结构化列表呈现，提升可读性。- 文档模板与样式统一：
docs/docs_standards/02_process_guide_template.md流程指南模板重排；docs/knowledge_base/model/README.md提示样式统一为引用块，便于后续维护。
AtlasAccount
17 天前 评论：
17 天前 评论：
atomgit-bot
17 天前 评论：
17 天前 评论：
17 天前 添加了label：ascend-cla/yes
ascend-robot
17 天前 评论：
17 天前 评论：
Thanks for your pull-request.
The full list of commands accepted by me can be found at here。
You can get sig-info at here
PR Approval Progress
✅ Congratulations! All modules have met the lgtm and approve requirements.
Module Approval Details
| module | lgtm status | approve status |
|---|---|---|
| repo-Ascend/msmodelslim | ✅ rookie_hongchuan, 潘杨杰 (2/2) | ✅ 潘杨杰 (1/1) |
💡 Tip:
- Committer can comment
/approveor/lgtm- Commenting
/approveimplies both code review (lgtm) and intent to merge (approve)
CLA Signature Pass
LeeQT, thanks for your pull request. All authors of the commits have signed the CLA. 👍
此处折叠了70条消息 查看更多
rookie_hongchuan
16 天前 评论：
16 天前 评论：
/lgtm
panyj1993
16 天前 评论：
16 天前 评论：
/approve
16 天前 添加了label：approvedlgtm
16 天前 合入了pull request
ascend-robot
16 天前 评论：
16 天前 评论：
Pull Request 已合并或已关闭。
If you want to solve this problem, you can click here to do it in the FAQs.
PR 提交说明
1. 影响面评估
接口变更（按需）： 无
输出件变更（按需）： 无
非兼容变更（按需）： 无
SIG 评审结论（按需）： 无
2. 修改描述
修改背景（可选）： msModelSlim 资料文档存在 FAQ 单篇过长、README 功能章节与业务流程对应关系不直观、部分文档链接失效等问题，新手用户检索与上手成本较高。
修改目的： 提升资料文档的易用性与可维护性：将 FAQ 重构为「统一索引 + 分类子文档」结构并补充 AI 可读元数据，优化 README 业务流程引导，统一文档模板与提示样式，便于用户检索与后续维护。
修改内容：（按「概念 - 变化」分条）
3. 功能验证
冒烟由 CI 门禁检查，无需填写「冒烟是否通过」。
复现步骤（可选）：
# 纯资料变更，无复现命令；已本地核对文档相对链接与目录结构一致性4. 自检（请逐项确认，不适用标 N/A）
典型安全编码问题
DT