2.4 KiB
id, title, status, date, updated, authors, tags
| id | title | status | date | updated | authors | tags | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ADR-0001 | ruflo-docs plugin contract — pinning, namespace coordination, document-worker integration, smoke as contract | Accepted | 2026-05-04 | 2026-05-09 |
|
|
Context
ruflo-docs (v0.1.0): docs-writer agent (Haiku model — cost-efficient for docs work), 2 skills (api-docs, doc-gen), 1 command (/ruflo-docs). Drives the document background worker via hooks_worker-dispatch.
Real surface used:
mcp__claude-flow__hooks_worker-dispatchwithtrigger: "document"(works; thedocumentworker is one of the 12 background workers per CLAUDE.md)mcp__claude-flow__memory_storefor drift detection stateBash,Read,Write,Grep,Globfor source/doc analysis
Standard gaps: no plugin-level ADR, no smoke test, no Compatibility section, no namespace coordination.
Decision
- Add this ADR (Proposed).
- README augment: Compatibility (pin v3.6), Namespace coordination (claims
docs-drift), document-worker contract (which trigger maps to which output), Verification + Architecture Decisions. - Bump
0.1.0 → 0.2.0. Keywords addjsdoc,openapi,mcp. scripts/smoke.sh— 10 checks: version + keywords; both skills + agent + command with valid frontmatter;hooks_worker-dispatchreferenced;documentworker trigger documented; v3.6 pin; namespace coordination; ADR Proposed; no wildcard tools; agent uses Haiku model (cost-efficient cadence).
Consequences
Positive: plugin joins the cadence. Document-worker integration becomes contractually documented.
Negative: none.
Verification
bash plugins/ruflo-docs/scripts/smoke.sh
# Expected: "10 passed, 0 failed"
Related
plugins/ruflo-agentdb/docs/adrs/0001-agentdb-optimization.mdplugins/ruflo-adr/docs/adrs/0001-adr-plugin-pattern.md— sibling docs cadenceplugins/ruflo-loop-workers/...— defines thedocumentbackground worker
Implementation status
Plugin version v0.2.0 shipped and listed in marketplace.json. Source exists at plugins/ruflo-docs/. Contract elements implemented: document background worker dispatch via hooks_worker-dispatch; namespace docs-state claimed for drift-detection state; Haiku model pinned for cost-efficiency; smoke-as-contract gate defined in scripts/smoke.sh.