Skip to content

docs: explain the stage graph mental model #179

@joshua-temple

Description

@joshua-temple

New users struggle to form a mental model of how cascade moves a change from trunk through
environments to a release. The capabilities are documented piece by piece, but there is no
single page that shows the stage graph: trunk to per-environment promotion to the release
boundary, and where rollback and hotfix branch off.

Add a documentation page that presents the stage graph as the primary mental model, with a
diagram and a short narrative tying each stage to the manifest fields and generated
workflows that implement it.

Proposed approach:

  • One new docs page with a stage-graph diagram (trunk, environments in order, the
    prerelease and release boundary, rollback and hotfix off-ramps).
  • Cross-link from the README and the capabilities and CLI reference pages.

Acceptance criteria:

  • A docs page exists that shows the full stage graph and explains each stage.
  • The page links the stages to the manifest fields and generated workflows that realize
    them.
  • README points to it as the recommended starting point for the mental model.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions