Skip to content

Workflows

ADR Authoring

  1. Identify a migration decision that needs recording.
  2. Draft an ADR in docs/adr/ following the template in the ADR index.
  3. Add the ADR entry to docs/adr/index.md.
  4. Add the ADR entry to mkdocs.yml nav.
  5. Update docs/guidelines/index.md if the ADR maps to an adoption objective.
  6. Run mkdocs serve to validate.

Document Publishing

Source (GitHub/WorkBuddy) → mkdocs build → COS archive → EdgeOne CDN → WeCom share
  1. Build: mkdocs build -d /tmp/site-build (or WorkBuddy generates HTML)
  2. Archive: bash publish-doc-site/scripts/publish.sh ./site-build internal/<project>
  3. Serve: EdgeOne CDN at docs.omnivoltaic.cn
  4. Share: Paste URL to WeCom group → opens in WeCom browser

MCP Contract

  1. Update docs/agent/manifest.yaml when authority order or resource roots change.
  2. Update docs/context/ files when repo capabilities, workflows, or contracts change.
  3. Re-run python D:\github\workspace-mcp\scripts\mcp_provision.py tencent-cloud to refresh registry state.