d22f795b56
- Simplify root README to focus on implemented features and quick navigation - Replace verbose project structure with concise feature list - Remove recent achievements section (moved to release notes) - Add direct links to master index and main documentation - Update MASTER_INDEX.md to focus on documentation catalog - Remove project completion status (moved to release notes) - Remove learning path sections (kept in individual path
11 KiB
11 KiB
AITBC Documentation Master Index
Complete documentation catalog with quick access to all content
Last Updated: April 23, 2026
🧭 Quick Access Table of Contents
📚 Learning Paths
- 👤 Beginner Path - Start here (6 topics)
- 🤖 Agent SDK Path - Agent communication (3 topics)
- 🌉 Intermediate Path - Bridge concepts (7 topics)
- 🚀 Advanced Path - Deep technical (6 topics)
- 🎓 Expert Path - Specialized expertise (6 topics)
- 🧠 AI Economics Masters Path - Advanced AI economics (4 topics)
📁 Documentation Categories
- 📦 Applications Documentation - All AITBC apps and services documentation
- 🔧 CLI Documentation - Command-line interface reference and usage
- 🏠 Main Documentation
- 📖 About Documentation
- 🗂️ Archive & History
- ✅ Completed Projects
- 🔗 External Documentation
- 🎯 Topic-Specific Areas
- 📋 Releases - Release notes and version history
📦 Applications Documentation
🎯 Apps Overview
Complete documentation for all AITBC applications and services
Blockchain
- Blockchain Node - Production-ready blockchain node with PoA consensus
- Blockchain Event Bridge - Event bridge for blockchain events
- Blockchain Explorer - Blockchain explorer and analytics
Coordinator
- Coordinator API - Job coordination service
- Agent Coordinator - Agent coordination and management
Agents
- Agent Services - Agent bridge, compliance, protocols, registry, and trading
- AI Engine - AI engine for autonomous agent operations
Exchange
- Exchange - Cross-chain exchange and trading platform
- Exchange Integration - Exchange integration services
- Trading Engine - Trading engine for order matching
Marketplace
- Marketplace - GPU marketplace for compute resources
- Pool Hub - Pool hub for resource pooling
Wallet
- Wallet - Multi-chain wallet services
Infrastructure
- Monitor - System monitoring and alerting
- Multi-Region Load Balancer - Load balancing across regions
- Global Infrastructure - Global infrastructure management
Plugins
- Plugin Analytics - Analytics plugin
- Plugin Marketplace - Marketplace plugin
- Plugin Registry - Plugin registry
- Plugin Security - Security plugin
Crypto
- ZK Circuits - Zero-knowledge circuits for privacy
Compliance
- Compliance Service - Compliance checking and regulatory services
Mining
- Miner - Mining and block validation services
Global AI
- Global AI Agents - Global AI agent coordination
Explorer
- Simple Explorer - Simple blockchain explorer
🔧 CLI Documentation
🎯 CLI Overview
Complete command-line interface documentation
| Section | Description |
|---|---|
| CLI Architecture | CLI structure and design |
| Command Groups | Available command categories |
| Usage Examples | Common CLI operations |
| Configuration | CLI setup and config files |
📋 Releases
🎯 Release Notes
Complete release history and version information
| Version | Date | Status | Key Features |
|---|---|---|---|
| v0.3.2 | April 23, 2026 | ✅ Stable | Test infrastructure, CLI refactoring, CI/CD standardization |
| v0.3.1 | April 13, 2026 | ✅ Stable | Milestone tracking fix, test cleanup |
| v0.3.0 | March 30, 2026 | ✅ Stable | Multi-node sync, consensus improvements |
| v0.2.5 | March 30, 2026 | ✅ Stable | Enhanced monitoring, security hardening |
| v0.2.4 | March 15, 2026 | ✅ Stable | Exchange integration, marketplace improvements |
| v0.2.3 | March 1, 2026 | ✅ Stable | Initial production release |
🏠 Main Documentation
📚 Documentation Home
- 🎯 Purpose: Main entry point and overview
- 📊 Content: Project status, navigation guide, organization
- 🔗 Links: All documentation sections and external resources
📖 About Documentation
Documentation about the documentation system itself:
| File | Purpose |
|---|---|
| 📊 Organization Analysis | Structure analysis and quality assessment |
| 🎯 10/10 Roadmap | Path to perfect documentation quality |
| 🗂️ Archive Structure Fix | Archive reorganization documentation |
| 📚 Centralization Guide | Documentation centralization process |
| 📋 Sorting Summary | Documentation sorting and organization |
🤖 Agent SDK Documentation
Complete documentation for OpenClaw agent communication:
| File | Purpose |
|---|---|
| 📱 Agent Communication Guide | Comprehensive agent communication guide |
| 🚀 Quick Start Guide | Get started in 5 minutes |
| 📚 API Reference | Complete API documentation |
🗂️ Archive & History
📚 Archive Documentation
65 historical documents organized in 7 categories:
| Category | Files | Content |
|---|---|---|
| 📊 Analytics | 6 files | AI agent communication analysis |
| 🔧 Backend | 3 files | Backend system documentation |
| 💻 CLI | 16 files | CLI implementation and testing |
| 📋 Core Planning | 5 files | Planning and requirements |
| 📚 General | 16 files | General project documentation |
| 🏗️ Infrastructure | 10 files | Infrastructure and deployment |
| 🔒 Security | 7 files | Security and compliance |
✅ Completed Projects
📋 Completed Projects
Project tracking and completion documentation:
| Category | Focus | Status |
|---|---|---|
| 🔧 Backend | Backend implementations | Production-ready |
| 💻 CLI | CLI enhancements | Integrated |
| 📋 Core Planning | Architecture work | Implemented |
| 🏗️ Infrastructure | Infrastructure projects | Operational |
| 🔒 Security | Security initiatives | Deployed |
| 📊 Summaries | Project overviews | Documentation complete |
| 🛠️ Maintenance | System improvements | Validated |
🔗 External Documentation (Symlinks)
📚 Centralized External Access
All external documentation accessible from main docs directory:
| Link | Target | Content |
|---|---|---|
| 💻 CLI Technical | /cli/docs/ |
CLI technical documentation |
| 📜 Contracts | /contracts/docs/ |
Smart contract documentation |
| 🧪 Testing | /tests/docs/ |
Test documentation |
| 🌐 Website | /website/docs/ |
Website documentation |
| ⛓️ Blockchain Node | /apps/blockchain-node/docs/ |
Blockchain node docs |
🎯 Topic-Specific Areas
📚 Subject-Specific Documentation
| Area | Description | Status |
|---|---|---|
| 🔒 Security | Security best practices and implementation | Active |
| 🏛️ Governance | Governance and policy documentation | Active |
| 📋 Policies | Project policies and procedures | Active |
| 🔧 Infrastructure | System infrastructure documentation | Active |
| 📊 Analytics | Data analytics and AI documentation | Active |
| 📱 Mobile | Mobile application documentation | Active |
| 🔄 Exchange | Exchange system documentation | Active |
| 🛠️ Development | Development workflow documentation | Active |
| 🚀 Deployment | Deployment guides and procedures | Active |
| 📝 Implementation | Implementation details and guides | Active |
| 🔧 Maintenance | Maintenance procedures and guides | Active |
| 👥 Project | Project information and coordination | Active |
📋 Project Documentation
Core project documentation and implementation guides:
| Category | Files | Content |
|---|---|---|
| 🧠 AI Economics | 1 file | Advanced AI economics intelligence |
| 💻 CLI | 1 file | Command-line interface documentation |
| 🏗️ Infrastructure | 4 files | System infrastructure and deployment |
| 📋 Requirements | 2 files | Project requirements and migration |
| ✅ Completion | 1 file | 100% project completion summary |
| 🔧 Workspace | 1 file | Workspace strategy and organization |
| 📈 Summaries | Project summaries and reports | Active | | 🔄 Workflows | Development and operational workflows | Active |
<EFBFBD> Welcome to AITBC Documentation!
This master index provides complete access to all AITBC documentation. For project status, learning paths, and getting started, see README.md.
Last updated: 2026-04-23