Skip to content

开发与知识发布规范 ​

1. 内容生命周期 ​

所有公开内容通过 Git 管理:

  1. Codex 在独立开发分支中创建代码或知识草稿。
  2. 尚未审核的教学文章放在 website/drafts/。
  3. 草稿不进入 VitePress 生产构建。
  4. 作者检查数学推导、引用、源码链接和实验数据。
  5. 审核通过后,将文章移动到 website/knowledge/、website/learning/ 或 website/tutorials/。
  6. 通过 Pull Request 合并到 main。
  7. 生产站点只从 main 分支部署。

注意:草稿目录不进入网站构建,但仓库是公开的,因此草稿文件本身仍然可以被 GitHub 访客读取。不要将私密信息、凭据、未授权论文全文或敏感数据放入该目录。

2. 文章模板\n\n从 website/templates/ 选择知识文章、算法说明、开发记录或 benchmark 报告模板。模板目录仅供复制,不作为网站页面发布;VitePress 构建会排除该目录。 ​

每篇知识文章至少包含:

  • 学习目标和适用读者;
  • 数学背景、符号和假设;
  • 算法步骤;
  • EONSim 对应代码路径;
  • 数值验证方法和证据;
  • 已知限制;
  • 参考文献和官方文档;
  • 练习或进一步阅读。

3. 证据分级 ​

文章必须区分:

  • 理论:由公开文献、教材或方程推导支持;
  • 实现:在指定 EONSim commit 中可以找到对应代码;
  • 验证:有可复现测试、算例配置和数值结果;
  • 性能:有明确硬件、软件版本、问题规模和容差的测量数据。

不能把计划写成已经实现,也不能把小规模测试描述成大规模 HPC 扩展证明。

4. Codex 任务交付\n\n对有复用价值的实质任务,按仓库根目录 .agents/skills/eonsim-knowledge-capture/SKILL.md 整理知识草稿,并更新 docs/research/KNOWLEDGE_LOG.md。跨 Task 工作使用 docs/development/CODEX_PROGRESS.md 和 CODEX_TASK_QUEUE.md 接续。 ​

每项开发任务结束时,Codex 应给出:

  • 变更文件和 commit;
  • 实际执行的构建与测试命令;
  • 测试通过/失败结果;
  • 性能数据及测试环境(如适用);
  • 新增知识草稿的路径;
  • 尚未验证的假设和下一步任务。

Codex 生成内容默认是草稿。只有经过人工审查并合并到 main 的内容才会进入正式网站。

Research, implementation and verification should remain traceable.