agilelabs-fx-docs main README.md

AgileLabs Framework 文档系统

文档系统规范

本文档系统的发布与管理方式以 mkdocs-net 为准。本仓库只维护 Markdown 内容结构、人工导航索引、AI Agent 约定和站内相对链接。

agilelabs.mkdocs 是 AgileLabs Framework 的统一文档仓库，同时服务于 /agilelabs 与 /agilelabs.aspnet。这套文档不是只有框架 API 的说明页，而是覆盖规则、专题、方案、教程、任务和参考资料的完整工程知识库，也作为 AI Agent 的稳定检索入口。

发布地址

六类目录说明

  • 规范 这里放正式规则、默认契约、跨层约定、合规要求，以及规范配套的自查文档。需要确认前后端契约、错误码处理、时间与时区、命名规范、Json/数据转换、目录架构和数据访问规则时，先看这里。
  • 专题概念 这里按能力主题解释原理、边界、扩展方式、常见坑和示例说明。需要理解 WebAPI、EnvelopMessage、AutoMapper、前端托管、WorkContext、数据访问、项目目录规划或 CI 组织方式时，先看这里。
  • 解决方案 这里沉淀可复用、可复查、带适用边界的项目方案。需要找认证、授权或其他可直接落地的方案型文档时，先看这里。
  • 教程 这里放从零搭建、连续上手和配套样例代码。需要按步骤创建前端或后端骨架、先看最终样例目录再回到正文时，先看这里。
  • 任务 这里按“我要做什么”组织落地入口。需要快速推进创建服务、做 WebAPI、托管前端、处理时间、多前端托管、运行 Job 等具体工作时，先看这里。
  • 参考资料 这里收纳低频但必要的包、测试、工具、CI/CD、迁移与发布资料。需要查 Drone、测试、工具说明或历史迁移资料时，先看这里。

使用方式

  • 要确认正式规则与自查口径，看 规范。
  • 要理解设计原因、扩展方式和常见坑，看 专题概念。
  • 要找可复用落地做法，看 解决方案。
  • 要从零搭建，看 教程。
  • 要按当前目标快速推进，看 任务。
  • 要查低频资料，看 参考资料。

推荐阅读顺序

  1. 第一次进入站点：先读本页，再进入 任务 或 教程。
  2. 想先确认正式规则和默认值：进入 规范。
  3. 想理解为什么这样设计、还能怎样扩展：进入 专题概念。
  4. 想复用现成落地做法：进入 解决方案。
  5. 想先看样例目录和关键文件：进入 教程配套代码总览。
  6. 想查 Drone、测试、工具、迁移或发布资料：进入 参考资料。

适用对象

  • 维护 AgileLabs Framework 的开发者。
  • 在 /agilelabs 与 /agilelabs.aspnet 中开发、排障、扩展功能的工程师。
  • 需要稳定检索文档并继续维护文档体系的 AI Agent。

目录收敛说明

  • 当前仓库已强收敛为六类主结构：framework-standards/、topics/、Solution/、tutorials/、tasks/、reference/。
  • checks/ 已并入 规范自查，真实用例已并入 项目案例，包、测试、数据访问迁移和发布资料已并入 参考资料。
  • 旧目录和旧兼容入口不再保留，历史 URL 不保证继续可用。

维护与校验

  • 发布与管理方式参考 mkdocs-net。
  • 人工可读导航索引保留在 navmenu.md。
  • 本仓库默认不要求本地执行 MkDocs 编译、mkdocs build 或 Python 检查。
  • 默认按人工审查口径确认 Markdown 结构、站内相对链接、导航索引和文档格式是否一致。

相关页面