文章应放置在哪里
根据主题选择分类,而不是根据启发草稿的源章节来选。
Issue 和 review 流程
在起草文章之前,先创建 GitHub issue。使用Content Proposal 表单,并选择 Lab article 或 Major revision to an existing lab page。
核心团队会先 review issue。他们可能批准 scope、请求修改,或拒绝 proposal。issue 被批准或确认之后,贡献者可以 fork 仓库并开始修改。
核心团队会再单独 review pull request。他们可能批准、请求修改,或拒绝 PR。如果 issue 或 PR 被拒绝,贡献者仍然可以保留自己的 fork,并在仓库外继续使用这些改动。
必需结构
每篇文章都应遵循:- metadata-schema.mdx 中的元数据契约
- Article Template 中的结构
SummaryWhy It MattersMental ModelArchitecture DiagramTool LandscapeTradeoffsCitationsReading ExtensionsUpdate Log
工作规则
- 使用仓库原生英文撰写。
- 概念和引用使用来源输入,而不是直接保留其行文。
- 保持图示简洁,并由仓库自有内容维护。
- 链接到相关的实验室页面,使文章成为更大地图的一部分。
- 保持页面具有长期适用性。如果某个说法很可能很快过时,要么验证它,要么 用不依赖时间的语言来写。
完成标准
当一篇文章满足以下条件时,即可进入审阅:- 与该分类清晰匹配
- 遵循元数据和章节模板
- 引用了主要来源
- 避免照搬上游教学流程
- 至少包含一个有用的内部阅读链接
