参与贡献

ArkFlow 文档与实现一同维护。一个页面应当帮助读者完成一项任务、理解某种行为,或查阅一份精确的参考资料。

页面契约

• 添加包含稳定 title/description 的 front matter,并在合适时设置经过考量的侧边栏位置。
• 在面向任务的页面开头附近说明目标读者与前置条件。
• 使用完整的命令与配置片段;说明预期结果。
• 链接到相关的概念页与参考页,而不是重复罗列规则。
• 当行为因版本而异时,添加兼容性或弃用提示。
• 新增或修改受支持的组件时,更新组件清单。

在发起 pull request 之前,先在 docs/ 下运行 pnpm docs:check 和 pnpm build。运行时行为的变更还应同步更新相关的 OpenSpec 变更与测试。

评审归属

• 组件页面:组件维护者与文档评审人。
• 概念/配置:运行时或 API 维护者。
• 部署/控制平面:运维或控制平面维护者。
• 发布/版本页面:发布维护者。

如果归属不明确,请向所改实现区域的维护者请求评审,并在 pull request 中说明预期的读者路径。