贡献指南

这个仓库希望在不断扩展时仍然保持结构一致。每次新增笔记时，都建议按下面的流程进行。

推荐工作流

1. 先为笔记选择最合适的主题目录。
2. 复制 笔记模板。
3. 使用清晰的 kebab-case 文件名保存新文件。
4. 先填写前置部分：标题、主题范围、参考资料和一句话摘要。
5. 把新笔记加入对应主题的索引页。
6. 如果这篇笔记需要出现在顶部导航中，再更新 mkdocs.yml。
7. 发布前尽量本地预览，例如使用 mkdocs serve。

写作约定

• 一篇笔记最好只覆盖一篇论文、一个概念、一个模型家族，或一组紧密相关的问题。
• 优先使用解释性文字，而不是堆砌原始要点。
• 使用简短但信息明确的小节标题。
• 能给出引用、链接或论文标识时尽量补上。
• 在合适的时候以开放问题或后续方向收尾。

文件命名

统一使用小写 kebab-case：

scaling-laws-notes.md
segment-anything-overview.md
multimodal-tokenization.md

主题索引维护

每个主题目录都应包含一个作为落地页的 index.md。新增笔记时：

• 在该主题索引页中添加一行简介和链接
• 保持笔记的组织逻辑清晰
• 当主要导航需要变化时再更新 mkdocs.yml

站内链接

• 相关笔记之间优先使用相对 Markdown 链接直接互链。
• 做宽泛导航时，优先链接到主题索引页。
• 当概念跨主题关联时，可以添加“另见”或“相关笔记”小节。

最低检查清单

• 清晰标题
• 简短摘要
• 背景或动机
• 核心思想或关键机制
• 参考资料
• 开放问题、注意事项或后续方向