Skip to main content

Docs-portal integration

A2C workflow documentation is docs-as-code in this repository. The docs-portal is the publication and discovery layer.

Model​

LayerRole
This repoAuthoritative workflow docs, rules, templates, prompts
docs-portalMirrored publication, site navigation, cross-workflow discovery

Workflow artifacts remain editable in Git here. The portal syncs on develop when docs/** changes.

What gets published​

  • Narrative docs under docs/ (per workflow-manifest.yaml sidebar_order)
  • Companion assets: templates/, rules/, prompts/, profiles/ → a2c-assets/
  • Doc images under docs/assets/ (e.g. TUI screenshots) → docs-a2c/assets/

Excluded from sync (metadata only):

  • portal-integration.md
  • navigation-meta.md
  • workflow-manifest.yaml

Onboarding checklist (maintainers)​

  1. Register a2c in docs-portal/workflows/registry.yaml with active: true
  2. Add docs-a2c/intro.md landing page in docs-portal
  3. Add Docusaurus plugin config (sidebarsA2c.ts, route a2c)
  4. Verify downstream trigger from this repo's .gitlab-ci.yml
  5. Confirm companion static assets appear under a2c-assets/

Until onboarding completes, CI still validates the manifest contract and triggers downstream — the portal may ignore unknown workflow ids until registered.

Project-local linkage​

A2C-based application projects keep their own docs/ and ADRs. The portal can link project docs to the A2C reference section once both are published.

Use pathname:///a2c-assets/templates/docs-portal/integration-note.md when documenting portal integration in a consumer project.