mirror of
https://github.com/ruvnet/ruflo.git
synced 2026-11-09 05:35:21 +09:00
Claude
ea23392bb0
Added 11 new sections (11.9-11.19) covering: - Shared types package (@claude-flow/types) - Monorepo management (pnpm + Turborepo + Changesets) - Testing strategy (unit, integration, e2e, mocks) - Error handling & recovery (error codes, circuit breaker) - Security model (secrets, sandboxing, PII, audit) - Telemetry & observability (OpenTelemetry, distributed tracing) - Migration path v2→v3 (codemods, compat shim, timeline) - Plugin & extension system (third-party hooks, agents) - Configuration cascade (6-level priority) - Build & CI/CD pipeline (GitHub Actions, changesets) - Offline & degraded mode (feature detection, fallbacks) Document now covers all aspects of modular package architecture.
📚 Claude-Flow Documentation
Welcome to the Claude-Flow documentation! This directory contains comprehensive guides and references for using Claude-Flow v2.7.0.
📖 Core Documentation
| Document | Description |
|---|---|
| INDEX.md | Complete documentation hub with navigation and quick start |
| USER_GUIDE.md | Comprehensive user guide with tutorials and examples |
| API_DOCUMENTATION.md | Complete API reference with all 112 MCP tools |
| AGENTS.md | All 65+ agent types with capabilities and usage |
| SWARM.md | Swarm intelligence, topologies, and coordination |
| SPARC.md | SPARC methodology with all 17 development modes |
| MCP_TOOLS.md | Detailed reference for all MCP tools |
| ARCHITECTURE.md | System architecture and design patterns |
| DEPLOYMENT.md | Production deployment guides for Docker, K8s, Cloud |
| DEVELOPMENT_WORKFLOW.md | Development setup and contribution guide |
📁 Documentation Categories
🚀 Releases
Release notes, changelogs, and version documentation
- v2.7.1 - Current stable release
- v2.7.0-alpha.10 - Alpha release notes
- v2.7.0-alpha.9 - Previous alpha release
- Alpha Tag Updates - Alpha versioning guide
🧠 AgentDB Integration
AgentDB v1.3.9 integration documentation (96x-164x performance boost)
- Implementation Complete - 3-agent swarm details
- Integration Plan - Planning and design
- Backward Compatibility - 100% compatibility guarantee
- Publishing Checklist - Pre-release verification
- Integration Summary - Quick overview
- Production Readiness - Deployment guide
- Optimization Report - Performance analysis
⚡ Performance
Performance optimization guides, metrics, and benchmarks
- JSON Improvements - JSON optimization results
- Metrics Guide - Performance tracking and analysis
🔧 Bug Fixes
Bug fix documentation and patch reports
- Pattern Persistence Fix - v2.7.1 critical fix
- Pattern Fix Confirmation - Verification and testing
- CLI Memory Commands - Memory command fixes
🛠️ Development
Internal development reports and implementation details
- Agent 1 Completion Report - AgentDB integration agent
- Final Init Structure - Initialization architecture
- Commands to Skills Migration - Migration guide
✅ Validation
Test reports and validation results
- Docker Verification Report - Docker testing results
📚 User Guides
Tutorials and learning resources
- Skills Tutorial - Complete guide to 25 Claude Flow skills
🔌 Integrations
Third-party platform integrations
- ReasoningBank (16 docs) - AI reasoning integration
- Agentic Flow (5 docs) - Agent flow system
- Agent Booster - Performance optimization
- Epic SDK - SDK integration
🏗️ Additional Resources
- Architecture - System architecture documentation
- Experimental - Experimental features
- Reference - API and command reference
- Setup - Setup and configuration guides
- CI/CD - Continuous integration workflows
- SDK - SDK documentation
- Wiki - Additional documentation
🚀 Quick Links
- Getting Started: See USER_GUIDE.md
- API Reference: See API_DOCUMENTATION.md
- Agent Catalog: See AGENTS.md
- Deployment: See DEPLOYMENT.md
- Skills Tutorial: See Skills Tutorial
- AgentDB Integration: See AgentDB
🎯 By User Type
👨💻 Developers
- Quick Start Guide - Get up and running
- Skills Tutorial - Natural language skill activation
- SPARC Development - Structured development methodology
- API Reference - Complete endpoint documentation
🏢 DevOps/Operations
- Deployment Guide - Production deployment
- Architecture Overview - System design
- Docker Verification - Testing reports
👑 Technical Leaders
- System Architecture - High-level design
- Performance Metrics - Benchmarks and optimization
- AgentDB Integration - 96x-164x performance improvements
📊 Performance Highlights
- 96x-164x faster search - AgentDB vector search improvements
- 4-32x memory reduction - Quantization benefits
- 84.8% SWE-Bench solve rate - Industry-leading performance
- 32.3% token reduction - Efficient context management
- 2.8-4.4x speed improvement - Parallel coordination
📞 Support
- GitHub Issues: https://github.com/ruvnet/claude-flow/issues
- Discord: Join our community for real-time help
- Documentation Updates: PRs welcome!
Last Updated: January 2025 | Version: v2.7.1