tasq/node_modules/agentic-flow/docs/README.md

Agentic-Flow Documentation

Complete documentation for the agentic-flow platform - AI agent orchestration with 66 specialized agents, 213 MCP tools, ReasoningBank learning memory, and autonomous multi-agent swarms.

📚 Documentation Structure

Core Documentation

• CLAUDE.md - Claude Code configuration and SPARC development environment setup

Quick Start & Guides

• guides/ - User guides, tutorials, and how-to documentation
  • Quick Start Guide
  • MCP Tools
  • Claude Code Integration
  • Agent Booster
  • ReasoningBank
  • Multi-Model Router
  • Deployment Guide

Architecture & Design

• architecture/ - System architecture and design documents
  • Executive Summary
  • Package Structure
  • QUIC Implementation
  • Integration Status
  • Improvement Plan

Integration Documentation

• integration-docs/ - Integration guides and implementation summaries
• integrations/ - Specific integration implementations
  • Claude Flow Integration
  • Flow Nexus Integration
  • FastMCP Integration

Feature Documentation

Provider & Router

• providers/ - Provider fallback and configuration
  • Provider Fallback Guide
  • Provider Fallback Summary
  • Landing Page Provider Content
• router/ - Multi-model router documentation
  • Router User Guide
  • Router Config Reference

QUIC Transport

• quic/ - QUIC protocol implementation
  • QUIC Status
  • Implementation Complete
  • Final Validation
  • Performance Validation

ReasoningBank

• reasoningbank/ - ReasoningBank learning memory system
  • Architecture
  • Backends
  • Benchmark Results
  • Validation

Supabase Integration

• supabase/ - Supabase realtime federation
  • Quick Start
  • Implementation Summary
  • Test Report

Federation

• federation/ - Agent federation and deployment
  • Deployment Validation
  • Debug Streaming

Testing & Validation

• testing/ - Test documentation and results
  • Agent System Validation
  • Final Testing Summary
  • Regression Test Results
• validation/ - Validation reports and processes
• validation-reports/ - Detailed validation results
  • Docker Validation
  • No Regressions Confirmed
• docker-tests/ - Docker test configurations

MCP Validation

• mcp-validation/ - Model Context Protocol validation
  • MCP CLI Validation Report
  • Implementation Summary

Benchmarks & Performance

• benchmarks/ - Performance benchmarks
  • QUIC Results
  • Optimization Guide

Release Information

• releases/ - Release notes and GitHub issues
  • v1.8.13 Release
  • v1.5.14 QUIC Transport
  • v1.4.6 ReasoningBank
• version-releases/ - Version-specific release documentation

Planning & Research

• plans/ - Feature plans and roadmaps
  • QUIC Implementation
  • Agent Booster
  • Requesty
• quantum-goap/ - Goal-Oriented Action Planning
• quantum-research/ - Quantum research literature

Issues & Reports

• issues/ - Known issues and troubleshooting
  • Supabase Integration Issue
  • Xenova Transformers Dependency
• reports/ - Status reports and completion summaries
• reviews/ - Code and implementation reviews

Archived Documentation

• archived/ - Historical documentation (kept for reference)
  • Old validation reports
  • Deprecated integration guides
  • Previous version documentation

🚀 Quick Links

Getting Started

1. Quick Start Guide
2. Claude Code Setup
3. Installation Guide

Core Features

• 66 Specialized Agents
• 213 MCP Tools
• ReasoningBank Learning
• Multi-Model Router
• QUIC Transport

Integration

• Claude Flow
• Flow Nexus
• FastMCP
• Supabase

Development

• Architecture Overview
• SPARC Methodology
• Testing Guide

📖 Documentation Standards

File Organization

• Use descriptive filenames in UPPERCASE-WITH-DASHES.md format
• Group related docs in topic-specific directories
• Keep root directory minimal (README, CLAUDE, LICENSE only)

Content Guidelines

• Start with a clear title and description
• Include table of contents for docs > 200 lines
• Use code blocks with language identifiers
• Add examples and use cases where applicable

Directory Structure

docs/
├── README.md              # This file
├── CLAUDE.md             # Claude Code config
├── LICENSE               # License file
├── architecture/         # System architecture
├── guides/              # User guides
├── integration-docs/    # Integration documentation
├── integrations/        # Specific integrations
├── testing/            # Test documentation
├── releases/           # Release notes
├── issues/             # Known issues
├── providers/          # Provider configuration
├── quic/              # QUIC implementation
├── reasoningbank/     # ReasoningBank docs
├── router/            # Router documentation
├── supabase/          # Supabase integration
└── archived/          # Historical docs

🔍 Search Tips

Finding Documentation

• Use grep -r "keyword" docs/ to search all docs
• Check the appropriate category directory first
• Look in archived/ for historical documentation

Common Topics

• Setup: See guides/ and CLAUDE.md
• API Reference: See integration-docs/
• Troubleshooting: See issues/
• Performance: See benchmarks/
• Releases: See releases/ and version-releases/

🤝 Contributing to Docs

Adding New Documentation

1. Identify the appropriate directory
2. Follow naming conventions
3. Include proper frontmatter/headers
4. Update this README index
5. Add cross-references as needed

Updating Existing Docs

1. Keep archived versions if major changes
2. Update last modified date
3. Maintain backward compatibility links
4. Test all code examples

📞 Support

• GitHub Issues: https://github.com/ruvnet/agentic-flow/issues
• Documentation Updates: Submit PR to docs/ directory
• Questions: Check issues/ directory first

---

Last Updated: November 6, 2025 Version: 1.9.1