agilelabs-fx-docs main start/ai-agent-guide.md

AI Agent 使用约定

这套文档是 /agilelabs 与 /agilelabs.aspnet 共用的 AI Agent 文档系统。AI Agent 应把这里视为稳定知识源，而不是一次性迁移副本。

外部发布地址：https://mkdocs.feinian.net/agilelabs-fx-docs/

阅读顺序

  1. 先看 开始。
  2. 再看 文档结构与阅读路径。
  3. 然后进入 任务入口 或 主题手册。

编写规则

  • 每个页面必须有明确 H1。
  • 页面开头先说明这页解决什么问题。
  • 主阅读入口优先放在 start/、tasks/、topics/、real-usecases/、reference/。
  • 站内链接统一使用相对 .md 路径。
  • 新内容优先并入已有主题页，而不是继续扩散新的平级目录。
  • 如需保留旧路径，应改成兼容页并指向新位置。
  • 教程正文统一维护在 tutorials/，不再往 tutorial/ 补主内容。
  • 教程配套代码统一维护在 samples/tutorials/，样例 README 负责说明最终目录边界、运行方式和回链。
  • samples/tutorials/ 只保留源码级最终样例，不提交 bin/、obj/、dist/ 等生成产物。

导航规则

  • 左侧导航由 mkdocs.yml 驱动。
  • navmenu.md 只保留人工可读的总索引，不再作为站点配置源。
  • 一级栏目尽量少，二级链接尽量直达正文页。
  • 不把三级导航当默认结构使用。
  • 案例页从主题页和任务页就近进入。

维护要求

  • 修改主结构后，同步检查首页、导航和兼容页。
  • 不保留虚构路径、占位文案或失效入口。
  • 对共享概念优先写通用规则，再补项目差异。
  • 提交前运行 python3 scripts/check_docs.py。

相关页面