Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,14 @@ codegraph explore "binding Service Install"

## 文档维护

README、workflow、Taskfile 和 AI Agent Kit 里的命令必须对应当前仓库文件。历史 ADR 与已完成的计划文档可以保留背景,但必须明确标记状态,不能作为操作指南。
`docs/` 按受众分层,新增文档时先选对位置:

- `docs/` 根:当前有效的规范与政策,读者可以直接照着执行。
- `docs/ai-agent-kit/`:面向使用者的操作文档。默认路径是下载发行包,不是从源码构建。
- `docs/decisions/`:ADR。被推翻的决策保留原文并标注 Superseded 及其去向,不删改历史。
- `docs/internal/`:维护者视角的完工记录与验证清单。不放未实施的计划——那属于 issue。

README、workflow、Taskfile 和 AI Agent Kit 里的命令必须对应当前仓库文件。`docs/internal/`
里引用已移除工具的命令块用 ` ```text ` 而不是 ` ```bash `,避免被当成可运行指令。

`LICENSE` 是 Apache-2.0,`NOTICE` 是第三方归属的真源。新增随包分发的依赖,或在界面里加入新的第三方标识时,必须同步 `NOTICE`——`docs/distribution-compliance-policy.md` 把它列为发布前置条件。
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,14 +139,27 @@ GitHub Actions 而移除。第三方归属现在维护在仓库根的 [NOTICE](N

## 文档

- [Wails v3 迁移收尾计划](docs/wails-v3-migration-plan.md)
- [发行与合规政策](docs/distribution-compliance-policy.md)
`docs/` 按受众分三层:根下是当前有效的规范,`decisions/` 是架构决策,
`internal/` 是维护者视角的历史记录。

**使用与规范**

- [AI Agent Kit](docs/ai-agent-kit/00-start-here.md):从零配置一个 Agent 环境
- [产品边界基线](docs/product-boundary-baseline.md):做什么、不做什么,以及为什么
- [分发与合规政策](docs/distribution-compliance-policy.md):发行前的权利、安全与渠道要求
- [公开站运营手册](docs/public-site-operations.md)
- [Provider RC 测试说明](docs/provider-rc-testing.md)
- [AI Agent Kit](docs/ai-agent-kit/00-start-here.md)
- [Wails 架构 ADR](docs/decisions/ADR-007-wails-v3-go-migration.md)
- [按 Agent 协议验证 ADR](docs/decisions/ADR-004-per-agent-protocol-verification.md)
- [历史 Python 发行 ADR(已废弃)](docs/decisions/ADR-003-three-platform-python-core-and-release-policy.md)

**架构决策**

- [decisions/](docs/decisions/):ADR-001 至 ADR-009,含已被取代的决策及其去向
- [Wails v3 / Go 迁移](docs/decisions/ADR-007-wails-v3-go-migration.md)
- [按 Agent 协议验证](docs/decisions/ADR-004-per-agent-protocol-verification.md)
- [凭据写入 Agent 配置文件](docs/decisions/ADR-008-credentials-in-agent-config-files.md)

**内部实现记录**

- [internal/](docs/internal/README.md):各次改造的完工记录与验证清单。里面的命令可能已随
工具移除而失效,该目录的 README 说明了当前的替代入口。

## 许可证

Expand Down
Loading