Skip to content

docs: add cascade-themed mermaid diagrams to readme and docs - #130

Merged
joshua-temple merged 1 commit into
mainfrom
docs/mermaid-diagrams
Jun 13, 2026
Merged

joshua-temple merged 1 commit into
mainfrom
docs/mermaid-diagrams

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

Problem: the root README and docs explained the pipeline with ASCII box diagrams, and the docs mermaid theming did not reflect the cascade teal brand.

Fix:

  • README "How it works" ASCII flow replaced with a Mermaid flowchart (manifest to generate-workflow to generated workflows to Orchestrate to Promote cascade to Release lifecycle). Removed the stale TODO image placeholder. Themed with a per-diagram init directive (theme base + teal/copper themeVariables) tuned to read on both GitHub light and dark backgrounds.
  • docs astro-mermaid given cascade-teal mermaidConfig themeVariables (teal edges, borders, cluster outlines; copper secondary accent), kept autoTheme so node fills/text stay legible in both Starlight light and dark modes.
  • Converted ASCII diagrams to Mermaid in architecture.md (System Overview, Primary/Satellite multi-repo) and workflows.md (Orchestrate flow, Promote flow). Existing state-machine diagram preserved.

Verification:

  • All Mermaid blocks (README + 4 docs) parse via mermaid-cli.
  • cd docs && npm run build succeeds (9 pages); astro-mermaid transforms the blocks and the teal themeVariables are baked into the page output.

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-temple merged commit 7fd9147 into main Jun 13, 2026
8 checks passed
@joshua-temple joshua-temple added the docs Improvements or additions to documentation label Jun 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant