Skip to main content
LiveJob Architecture

Live for configured pilot tenants

Contributing to Cadence Docs

Guide authors can land Markdown or MDX into the matching folder under docs-site/docs/.

Required frontmatter​

Every doc must include:

---
title: Guide title
capabilityKey: jobArchitecture
status: live
docType: how-to
---

capabilityKey and status must match docs-site/src/data/capabilities.ts. The build fails if they drift.

Publishing rule​

Only live capabilities can publish docType: how-to guides. coming and gated pages must use docType: overview until Morgan Wells confirms the capability is live for a paying customer and updates the registry.

Author checklist​

  • Put the guide in the matching IA folder under docs-site/docs/.
  • Add the doc id to sidebars.ts.
  • Include a CapabilityStatus block near the top of the page.
  • Run npm run validate:publishing from docs-site/.
  • Run npm run build before opening the PR.