Skip to content

docs: add architecture and workflow diagrams - #8

Merged
saintdle merged 1 commit into
mainfrom
docs/architecture-workflow-diagrams
Aug 3, 2026
Merged

docs: add architecture and workflow diagrams#8
saintdle merged 1 commit into
mainfrom
docs/architecture-workflow-diagrams

Conversation

@saintdle

@saintdle saintdle commented Aug 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • add a top-level Mermaid component map showing Agentflow, Beads, provider lanes, workspaces, results, and Git/GitHub
  • add a persistent-controller lifecycle diagram covering approval, preflight, claims, review, remediation, halts, and completion
  • add a security trust-boundary diagram for controller authority, task-scoped workers, external providers, return contracts, and integration
  • add regression tests for diagram presence, critical paths, and balanced Mermaid fences

Visual verification

  • rendered all three diagrams with pinned Mermaid CLI 11.12.0
  • completed two visual passes
  • reflowed the README diagram vertically and humanized lifecycle labels after the first pass
  • confirmed no connector crosses a node or obscures another label

Validation

  • full suite: 453 tests passed, 1 skipped
  • python3 scripts/validate.py
  • git diff --check

Beads: agentflow-aot

This PR will not merge itself.

@saintdle
saintdle merged commit cf7ed29 into main Aug 3, 2026
11 checks passed
@saintdle
saintdle deleted the docs/architecture-workflow-diagrams branch August 3, 2026 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant