Skip to content

feat: docs/cicd/bmad standardization#318

Merged
chendelin1982 merged 2 commits intodevfrom
feat/docs-cicd-bmad-standardization
Mar 4, 2026
Merged

feat: docs/cicd/bmad standardization#318
chendelin1982 merged 2 commits intodevfrom
feat/docs-cicd-bmad-standardization

Conversation

@zhaojing1987
Copy link
Contributor

文档清理:

  • 删除占位文件 Notes.md、add_apps.md
  • developer.md 重命名为 CONTRIBUTING.md 并全面重写(分支策略、PR 规范、文档10条原则、i18n、Docsearch)
  • 新建 DEVELOPMENT.md(本地开发命令、模板系统、工作流说明、BMAD Quick Flow + Mermaid 流程图、App 文档创建 Step 0-5)
  • 重写 README.md(CI badge、Tech Stack、快速开始、项目结构、文档链接)
  • 初始化 CHANGELOG.md(Keep a Changelog 格式)
  • 更新 docs/readme.md 为 next 版本说明

CI/CD 升级:

  • build_doc.yml: checkout@master→@v4、删 Debug step、修 Docker 缩进、yarn cache、concurrency、dev/main 分支分离、apidocs continue-on-error
  • check.yml: 全量重写,lychee-action@v2 broken-links 检查,新增 pull_request 触发
  • app_from_contentful.yml: checkout@v2→@v4、setup-python@v2→@v5、pip cache、移除 --override
  • json2md.yml: checkout@v2→@v4、setup-python@v2→@v5、pip cache、curl retry
  • update.yml: checkout@v2→@v4
  • 新建 .lycheeignore broken-links 排除规则

BMAD + App 文档模板:

  • 新建 template/docs/zh/app.md Quick Flow App 文档 Prompt 模板

文档清理:
- 删除占位文件 Notes.md、add_apps.md
- developer.md 重命名为 CONTRIBUTING.md 并全面重写(分支策略、PR 规范、文档10条原则、i18n、Docsearch)
- 新建 DEVELOPMENT.md(本地开发命令、模板系统、工作流说明、BMAD Quick Flow + Mermaid 流程图、App 文档创建 Step 0-5)
- 重写 README.md(CI badge、Tech Stack、快速开始、项目结构、文档链接)
- 初始化 CHANGELOG.md(Keep a Changelog 格式)
- 更新 docs/readme.md 为 next 版本说明

CI/CD 升级:
- build_doc.yml: checkout@master→@v4、删 Debug step、修 Docker 缩进、yarn cache、concurrency、dev/main 分支分离、apidocs continue-on-error
- check.yml: 全量重写,lychee-action@v2 broken-links 检查,新增 pull_request 触发
- app_from_contentful.yml: checkout@v2→@v4、setup-python@v2→@v5、pip cache、移除 --override
- json2md.yml: checkout@v2→@v4、setup-python@v2→@v5、pip cache、curl retry
- update.yml: checkout@v2→@v4
- 新建 .lycheeignore broken-links 排除规则

BMAD + App 文档模板:
- 新建 template/docs/zh/app.md Quick Flow App 文档 Prompt 模板
按行业规范补充:PR 向 dev 分支时触发构建验证,确保不会将破坏构建的变更
合并进 dev。部署步骤已有 if: github.ref == 'refs/heads/main' 保护,
PR 时只 build 不 deploy。
@chendelin1982 chendelin1982 merged commit 8329a4c into dev Mar 4, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants