mirror of https://github.com/ruvnet/ruflo.git synced 2026-09-14 14:01:28 +08:00

Files

T

Reuven 0648218312 feat(ruflo-docs): v0.2.0 — adopt plugin contract (ADR-0001, document-worker contract, namespace coordination)

- ADR-0001 (Proposed) at docs/adrs/0001-docs-contract.md
- README adds Compatibility (pin v3.6, Haiku agent model), Document-worker
  contract (trigger:document with optional scope: api or file path),
  Namespace coordination (claims docs-drift for drift-detection state),
  Verification + Architecture Decisions sections
- plugin.json bumps 0.1.0 → 0.2.0; description names the document worker;
  keywords add jsdoc, openapi, mcp
- scripts/smoke.sh — 10 structural checks: version + keywords, 2 skills
  with frontmatter, agent + command present, hooks_worker-dispatch
  referenced, document trigger doc'd, v3.6 pin, namespace coordination,
  docs-drift claimed, scope table doc'd, ADR Proposed, agent uses Haiku

Verification: bash plugins/ruflo-docs/scripts/smoke.sh → 10/10

Co-Authored-By: RuFlo <ruv@ruv.net>

2026-05-04 20:01:39 -04:00

2.5 KiB

Raw Blame History

ruflo-docs

Documentation generation, drift detection, and API docs automation.

Install

/plugin marketplace add ruvnet/ruflo
/plugin install ruflo-docs@ruflo

What's Included

Auto-Documentation: Background worker generates docs from code changes
Drift Detection: Identifies when docs fall out of sync with implementation
API Docs: Automated API documentation from TypeScript interfaces and JSDoc
CAPABILITIES.md Generation: Full capabilities reference via init command
Document Worker: Background document worker triggers on API changes
SPARC Integration: Uses documenter and docs-writer agent patterns

Requires

ruflo-core plugin (provides MCP server)

Compatibility

CLI: pinned to @claude-flow/cli v3.6 major+minor.
Agent model: Haiku (cost-efficient for docs work).
Verification: bash plugins/ruflo-docs/scripts/smoke.sh is the contract.

Document-worker contract

Drives the document background worker (one of 12 workers in CLAUDE.md). Two invocation paths:

# CLI
npx @claude-flow/cli@latest hooks worker dispatch --trigger document
npx @claude-flow/cli@latest hooks worker dispatch --trigger document --scope api

# MCP
mcp tool call hooks_worker-dispatch --json -- '{"trigger": "document", "scope": "api"}'

Scope	Output
(none)	Full project documentation pass
`api`	API reference from JSDoc/TSDoc + OpenAPI 3.0 for HTTP endpoints
`<file-path>`	Single-file doc generation

Namespace coordination

This plugin owns the docs-drift AgentDB namespace (kebab-case, follows the convention from ruflo-agentdb ADR-0001 §"Namespace convention"). Used for drift-detection state (last-seen export hash per file). Reserved namespaces (pattern, claude-memories, default) MUST NOT be shadowed.

docs-drift is accessed via memory_* tools (namespace-routed).

Verification

bash plugins/ruflo-docs/scripts/smoke.sh
# Expected: "10 passed, 0 failed"

Architecture Decisions

ADR-0001 — ruflo-docs plugin contract (document-worker integration, namespace coordination, smoke as contract)

ruflo-agentdb — namespace convention owner
ruflo-loop-workers — defines the document background worker
ruflo-adr — ADRs trigger doc generation when status changes
ruflo-sparc — Documenter mode (Phase 5 Refinement) consumes this plugin

2.5 KiB Raw Blame History