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

Files

T

Claude 176f6ad235 docs: add comprehensive user documentation with guides, tutorials, and diagrams

13 documentation files covering all 20+ modules:

Guides:
- Getting Started: installation, setup, core loop
- Architecture Overview: 7-layer design with mermaid diagrams
- Multi-Agent Security: threats, collusion, quorum, trust
- Capabilities and Trust: permission algebra, trust tiers, authority
- Knowledge Management: uncertainty, temporal, truth anchors
- WASM Kernel: building, using, benchmarking

Tutorials:
- Enforcement Gates: wire gates into hooks
- ContinueGate: prevent runaway agent loops
- Proof & Audit Trail: tamper-evident chains
- CI/CD & Headless Testing: automated compliance

Reference:
- API Quick Reference: all exports, methods, types

Diagrams:
- 10 mermaid diagrams: system overview, enforcement pipeline,
  decision trees, trust flow, capability delegation, memory
  security layers, knowledge stack, proof chain, meta-governance
  lifecycle, compile-retrieve-gate sequence

https://claude.ai/code/session_01HLi9WmfvFgkDLJxLKGAUTf

2026-02-01 19:55:55 +00:00

3.4 KiB

Raw Permalink Blame History

@claude-flow/guidance Documentation

Guides

Conceptual explanations of how each system works.

Guide	Description
Getting Started	Installation, minimal setup, core loop
Architecture Overview	7-layer architecture, data flow, module map
Multi-Agent Security	Threat detection, collusion, quorum, trust
Capabilities and Trust	Permission algebra, trust accumulation, authority
Knowledge Management	Uncertainty, temporal assertions, truth anchors
WASM Kernel	Building, using, and benchmarking the Rust WASM kernel

Tutorials

Step-by-step walkthroughs for specific tasks.

Tutorial	Description
Enforcement Gates	Wire gates to block destructive ops and secrets
ContinueGate	Prevent runaway agent loops
Proof & Audit Trail	Create tamper-evident audit trails
CI/CD & Headless Testing	Automated compliance testing

Reference

Document	Description
API Quick Reference	All exports, methods, and types

Diagrams

Diagram	Description
System Diagrams	10 Mermaid diagrams: architecture, pipelines, decision trees

Architecture Decision Records

ADR	Title
G001	Guidance Control Plane
G002	Policy Compilation
G003	Shard Retrieval
G004	Enforcement Gates
G005	Run Ledger and Evaluators
G006	Rule Evolution Pipeline
G007	Hook Integration
G008	Persistent Ledger
G009	Headless Testing
G010	Deterministic Tool Gateway
G011	Artifact Ledger
G012	Evolution Pipeline
G013	Manifest Validator
G014	Cryptographic Proof Chain
G015	Memory Write Gate
G016	Coherence Scheduler
G017	Capability Algebra
G018	Conformance Kit
G019	RuvBot Integration
G020	Meta-Governance
G021	Adversarial Model
G022	Trust System
G023	Truth Anchors, Uncertainty, Temporal
G024	Authority Gate and Irreversibility
G025	WASM Policy Kernel

3.4 KiB Raw Permalink Blame History