📦 技术文档

📦 技术文档#

本目录集中承载 AgentForge 本项目 的技术相关文档。全部项目技术资产(包含 API 参考、集成指南、部署流程与变更日志)均位于本目录下,与同级 通用知识(传统文化、数学等)完全隔离。

技术文档

备注

api/taolib/ 目录由 sphinx-autoapi 在构建时从源码自动生成,不存在于版本库中。

目录清单#

路径

说明

intro.md

项目介绍与定位

quickstart.md

环境初始化与首次接入

features.md

核心功能与 .agents/ 详解

world-registry-protocol.md

World Registry 分发协议接口规格

world-cli-spec.md

World CLI 工具完整规格(含兼容性校验引擎设计)

world-session-spec.md

World Session 多端协同上下文容器协议(Draft v0.1)

github-app-token-override.md

GitHub App Token 覆盖头学习笔记

integration-guide.md

外部项目集成指南

api/taolib/

sphinx-autoapi 自动生成的 API 参考

deploy.md

文档托管、CI/CD 与发布流程

build-conventions.md

PDM / uv / mise 构建约定

fragment-manifest-spec.md

Fragment manifest.toml 完整格式规格

contributing.md

PR 流程、代码审查与测试要求

changelog.md + changelogs/

项目级变更索引与月度/技能变更镜像页

jupyterlite.md

JupyterLite 集成说明

边界#

不放置:传统文化、数学、通用知识等与本项目源码/工程化无直接关系的内容,请见同级目录 ../general/

接入约定#

新增技术文档时:

  1. 将文件放入本目录;

  2. 在本 index.mdtoctree 中追加对应文档名(无需 tech/ 前缀);

  3. 如需反向链接到 ../general/ 中的文档,使用相对路径(如 ../general/philosophy/tao-minimalist-principles.md)。