Skip to content

docs: add workflow patterns and templates documentation#451

Merged
khaliqgant merged 2 commits into
mainfrom
docs/workflow-documentation
Feb 19, 2026
Merged

docs: add workflow patterns and templates documentation#451
khaliqgant merged 2 commits into
mainfrom
docs/workflow-documentation

Conversation

@khaliqgant
Copy link
Copy Markdown
Member

@khaliqgant khaliqgant commented Feb 19, 2026

Summary

Creates markdown documentation for all available swarm workflow patterns and built-in templates, organized for easy browsing.

Location: docs/workflows/

Structure

docs/workflows/
├── README.md              # Overview with pattern/template tables
├── patterns/              # 10 swarm patterns
│   ├── dag.md
│   ├── fan-out.md
│   ├── pipeline.md
│   ├── hub-spoke.md
│   ├── consensus.md
│   ├── mesh.md
│   ├── handoff.md
│   ├── cascade.md
│   ├── debate.md
│   └── hierarchical.md
└── templates/             # 6 built-in templates
    ├── feature-dev.md
    ├── bug-fix.md
    ├── code-review.md
    ├── security-audit.md
    ├── refactor.md
    └── documentation.md

Each Pattern Doc Includes

  • Overview and description
  • When to use
  • YAML configuration example
  • Behavior notes

Each Template Doc Includes

  • Pattern used, timeout, channel
  • Agent table with roles
  • Workflow step diagram
  • CLI and TypeScript usage examples
  • Configuration details
  • Verification markers

Test plan

  • Verify markdown renders correctly on GitHub
  • Verify internal links work

🤖 Generated with Claude Code


Open with Devin

Creates markdown documentation for all available swarm workflows:

Patterns (10):
- dag: Directed acyclic graph with dependency edges
- fan-out: Parallel execution
- pipeline: Sequential step chaining
- hub-spoke: Central coordination
- consensus: Voting mechanism
- mesh: Full communication graph
- handoff: Sequential agent handoffs
- cascade: Waterfall with phase gates
- debate: Proposal and counter-argument
- hierarchical: Multi-level reporting structure

Templates (6):
- feature-dev: Plan, implement, review, finalize
- bug-fix: Investigate, patch, validate, document
- code-review: Parallel multi-reviewer assessment
- security-audit: Scan, triage, remediate, verify
- refactor: Analyze, plan, execute, validate
- documentation: Research, draft, review, publish

Each file includes:
- Overview and when to use
- Configuration examples
- Usage with CLI and TypeScript
- Step descriptions and verification markers

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
devin-ai-integration[bot]

This comment was marked as resolved.

1. Fix broken link to Workflow YAML Reference
   - Changed from ../broker-sdk/src/workflows/README.md
   - To ../../packages/broker-sdk/src/workflows/README.md

2. Fix incorrect onError value in security-audit.md
   - onError: fail (workflow-level setting)
   - errorStrategy: fail-fast (global errorHandling setting)
   - These are distinct settings per the schema

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@khaliqgant khaliqgant merged commit 87b9272 into main Feb 19, 2026
36 of 37 checks passed
@khaliqgant khaliqgant deleted the docs/workflow-documentation branch February 19, 2026 16:46
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