用途:为编写 Dagster 文档网站内容提供专家指引,在创建或更新 docs 目录中的文档前使用。
主要能力与结构指引:说明各章节对应的主要受众与编写规则。about 下的 changelog.md 由 /CHANGES.md 通过自定义 React 组件自动生成,不要直接编辑。api 与 integrations 下的 .mdx 由 sphinx 中的 .rst 生成,不应直接编辑,应改 .rst 或 python_modules 中的 docstring。migration/upgrading.md 由 /MIGRATION.md 自动生成,不要直接编辑。guides 子目录对应数据工程生命周期阶段:构建、自动化、运维、日志与调试、观测、测试。labs 子目录记录开发中的新功能,页面需引入 early access partial。partials 存放多处复用的文本。集成若含 component 实现,组件文档应放在该集成子目录的 index 页面。
必要前置步骤:运行命令前确保 docs/node_modules 存在,若缺失,在 /docs 执行 yarn install;运行 yarn start 前确保 docs/docs/api/**/*.mdx 存在,若缺失,在 docs 根目录执行 yarn build-api-docs。
验证方式:在 /docs 目录运行 yarn start,访问 http://localhost:3050 查看改动页面。
相关参考:audiences.md 描述主要受众;formatting-style.md 说明格式与风格约定;content-model 说明文档内容的结构与类型。
限制:缺失事实暂未提供,包括具体价格、平台支持范围、效果指标等。