本仓库文档分四类。【必读】 标记表示对应工作开始前应先读。版本与变更记录见仓库根的 CHANGELOG.md。
| 文档 | 作用 |
|---|---|
| ../CONTEXT.md | 产品定位、公开/私密内容边界。【任何产品改动必读】 |
| 草台编子识字班产品技术方案.md | 产品与技术总方案。【必读】 |
| 草台编子识字班插画美术规范.md | 木刻美术规范。【插画必读】 |
| 草台编子识字班论坛v1实现规格.md | 论坛 v1 实现规格。【论坛必读】 |
| 草台编子识字班-agent-access-v0.3技术方案.md | Agent 访问令牌与 MCP 首版实现方案。【MCP 必读】 |
| 草台编子识字班课程反馈v0.4实现规格.md | 课程反馈、课程讨论帖联动与后台统计规格。【课程反馈必读】 |
| 草台编子识字班论坛互动v0.4实现规格.md | 活跃排序、关注帖子、回复点赞、每日摘要与 MCP 互动工具。【论坛互动必读】 |
架构决策(ADR · adr/)
按日期累加,记录"为什么这么定"。新决策何时该加见 agents/domain.md。
| ADR | 主题 |
|---|---|
| 2026-06-21 D1 与账号权限基础 | 数据库分层、entitlement 模式。【论坛必读】 |
| 2026-06-21 暖纸墨绿 UI 方向 | 视觉基调 |
| 2026-06-21 Cloudflare 自定义域入口 | 部署入口 |
| 2026-06-21 DirectMail 邮箱 OTP | 邮件发送决策 |
| 2026-06-23 论坛与 Agent 接入模型 | 单一服务层 + 卡密门禁 + MCP。【论坛必读】 |
| 2026-06-23 MCP / 外部 API token 鉴权 | 用户授权令牌 + 实时 entitlement 门禁。【MCP 必读】 |
| 2026-07-03 课程反馈与论坛讨论分层 | 课程反馈作为统计真相,论坛承载公开讨论。【课程反馈必读】 |
Agent 工作规则(agents/)
| 文档 | 作用 |
|---|---|
| domain.md | 如何消费领域文档、何时加 ADR |
| issue-tracker.md | issue / 外部 PR 三角化 |
| triage-labels.md | 标签词表 |
| collaboration.md | 协作约定 |
| frontend.md | 前端与内容的已落地约定。【前端必读】 |
| course-content.md | 课程内容导入与公开/私密边界。【内容必读】 |
| mcp-agent-access.md | 学员 / Agent 通过 MCP 连接网站、读课程、读论坛、发帖和测试的操作文档。【MCP 必读】 |
| backend-status.md | 后端 / 部署当前状态、生产入口、验证命令、已知缺口(活文档,随版本更新) |
归档(archive/)
完成使命或被取代的文档,保留备查、不再维护。当前已归档:首页内容与素材需求(首页已填好上线)。
按顺序:
- ../CONTEXT.md — 公开/私密边界
- adr/2026-06-23-forum-and-agent-access-model.md — 论坛/Agent 接入决策
- 草台编子识字班论坛v1实现规格.md — 实现规格
- adr/2026-06-21-cloudflare-d1-auth-foundation.md — 论坛复用的 entitlement 模式
- agents/backend-status.md — auth / entitlement / profiles 已就位,是论坛前置
- agents/frontend.md — 前端约定
- agents/course-content.md — 公开/私密边界细则
按顺序:
- ../CONTEXT.md — 领域词汇与公开/私密边界
- adr/2026-07-03-course-feedback-and-forum-discussion.md — 反馈统计与论坛讨论分层决策
- 草台编子识字班课程反馈v0.4实现规格.md — 课程反馈本体规格
- 草台编子识字班论坛互动v0.4实现规格.md — 论坛互动与每日摘要规格
- 草台编子识字班论坛v1实现规格.md — 反馈文字同步论坛回复时复用的论坛规则
- agents/collaboration.md — 前后端分轮约定
- 发布里程碑与变更 → CHANGELOG.md;内容贡献不计入版本号。
- 新架构决策 → adr/(触发条件见 agents/domain.md)。
backend-status.md是活文档:已完成的工作归入 CHANGELOG,不在状态文档里重复堆积。