Skip to content
Book demo

Release

Documentation readiness gate before GA

Block GA until user docs, API docs, changelog entries, support macros, and examples are complete.

documentationgalaunch-readinessapi-docschangelogsupport-readiness

[ workflow / release ]

Documentation readiness gate before GA

Cosmos checks whether a feature is truly ready for general availability from a documentation perspective. It detects product and API surface changes, audits guides and examples, drafts missing content, and routes the launch package for docs and support approval before GA.

08 nodes

06 edges

Trigger[trigger]
GA candidate

Feature marked ready for launch review

AI Agent step[impact]
Detect docs impact

UX · API · setup · migration changes

AI Agent step[references]
Check docs and examples

Guides · API refs · changelog · macros

AI Agent step[draft]
Draft missing updates

Docs content + launch notes

Human-in-the-loop[approval]
Docs + support approval

Launch-facing content review

Decision

Docs complete?

No
AI Agent step[fix]
Patch missing docs

Examples · references · support copy

YES
Output / Result[output]
GA docs readiness

Ready / blocked with gaps

Workflow prompt

Paste this into Augment to reproduce the workflow end-to-end.

Cosmos, whenever a feature is marked as a GA candidate, run a documentation readiness gate before launch. Detect customer-facing UX changes, API contract changes, setup steps, limitations, and migration guidance needs by reading the implementation plan, merged PRs, and linked specs. Check for updates to user docs, API references, code examples, release notes, support macros, and onboarding material. Draft any missing documentation and summarize remaining gaps. Route the package to docs and support owners for approval, and only mark the feature docs-ready when all launch-facing content is complete.