Files
stack/docs/templates/README.md
Jason Woltje 53f2cd7f47
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
feat: Add self-contained orchestration templates and guide
Makes Mosaic Stack self-contained for orchestration - no external dependencies.

New files:
- docs/claude/orchestrator.md - Platform-specific orchestrator protocol
- docs/templates/ - Bootstrap templates for tasks.md, learnings, reports

Templates:
- orchestrator/tasks.md.template - Task tracking scaffold
- orchestrator/orchestrator-learnings.json.template - Variance tracking
- orchestrator/orchestrator-learnings.schema.md - JSON schema docs
- orchestrator/phase-issue-body.md.template - Gitea issue body
- orchestrator/compaction-summary.md.template - 60% checkpoint format
- reports/review-report-scaffold.sh - Creates report directory
- scratchpad.md.template - Per-task working document

Updated CLAUDE.md:
- References local docs/claude/orchestrator.md instead of ~/.claude/
- Added Platform Templates section pointing to docs/templates/

This enables deployment without requiring user-level ~/.claude/ configuration.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-05 16:37:58 -06:00

77 lines
3.0 KiB
Markdown

# Mosaic Stack Orchestration Templates
Templates for consistent orchestration setup within Mosaic Stack.
## Usage
### Variable Substitution
Templates use `${VARIABLE}` syntax. Substitute using `envsubst`:
```bash
# Set variables
export PROJECT="mosaic-stack"
export MILESTONE="M6-Security"
export CURRENT_DATETIME=$(date -Iseconds)
# Generate file from template (paths relative to repo root)
envsubst < docs/templates/orchestrator/tasks.md.template > docs/tasks.md
```
### Validation
Check for unsubstituted variables:
```bash
grep -rE '\$\{[A-Z_]+\}' docs/tasks.md && echo "WARN: Unsubstituted variables" || echo "OK"
```
## Standard Variables
| Variable | Description | Example |
| --------------------- | -------------------- | ----------------------- |
| `${PROJECT}` | Project identifier | `mosaic-stack` |
| `${MILESTONE}` | Milestone identifier | `M6-AgentOrchestration` |
| `${CURRENT_DATETIME}` | ISO datetime | `2026-02-05T20:00:00Z` |
| `${PHASE_NUMBER}` | Phase number | `1` |
| `${PHASE_ISSUE}` | Gitea issue number | `#337` |
| `${PHASE_BRANCH}` | Feature branch | `fix/security` |
| `${TASK_PREFIX}` | Task ID prefix | `MS-SEC` |
## Template Index
| Template | Purpose |
| --------------------------------------------------- | ------------------------------- |
| `orchestrator/tasks.md.template` | Task tracking table with schema |
| `orchestrator/orchestrator-learnings.json.template` | Variance tracking |
| `orchestrator/orchestrator-learnings.schema.md` | JSON schema documentation |
| `orchestrator/phase-issue-body.md.template` | Gitea issue body |
| `orchestrator/compaction-summary.md.template` | 60% checkpoint format |
| `reports/review-report-scaffold.sh` | Creates report directory |
| `scratchpad.md.template` | Per-task working document |
## Quick Start
```bash
# From mosaic-stack root
export PROJECT="mosaic-stack"
export MILESTONE="M7-NewFeature"
export CURRENT_DATETIME=$(date -Iseconds)
export TASK_PREFIX="MS-001"
export PHASE_ISSUE="#400"
export PHASE_BRANCH="fix/feature"
# Create tracking files
envsubst < docs/templates/orchestrator/tasks.md.template > docs/tasks.md
envsubst < docs/templates/orchestrator/orchestrator-learnings.json.template > docs/orchestrator-learnings.json
# Create review report structure
./docs/templates/reports/review-report-scaffold.sh codebase-review mosaic-stack
```
## Platform Integration
These templates are part of Mosaic Stack's orchestration system. The orchestrator guide at `docs/claude/orchestrator.md` references these templates.
**Self-contained:** All orchestration tooling ships with the platform. No external dependencies on `~/.claude/` or other repositories.