oib/aitbc
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity
Files
91bba69653f28527355bd2cac42ef0eb608bc799
aitbc/docs/MASTER_INDEX.md
aitbc d22f795b56
All checks were successful
Documentation Validation / validate-docs (push) Successful in 6s
Details
Documentation Validation / validate-policies-strict (push) Successful in 4s
Details
Python Tests / test-python (push) Successful in 12s
Details
Update README and documentation index for v0.3.2 release 
- 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
2026-04-23 17:04:03 +02:00

241 lines
11 KiB
Markdown
Raw Blame History

# 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](#-beginner-learning-path)** - Start here (6 topics)
- **🤖 [Agent SDK Path](#-agent-sdk-learning-path)** - Agent communication (3 topics)
- **🌉 [Intermediate Path](#-intermediate-learning-path)** - Bridge concepts (7 topics)
- **🚀 [Advanced Path](#-advanced-learning-path)** - Deep technical (6 topics)
- **🎓 [Expert Path](#-expert-learning-path)** - Specialized expertise (6 topics)
- **🧠 [AI Economics Masters Path](#-ai-economics-masters-learning-path)** - Advanced AI economics (4 topics)
### **📁 Documentation Categories**
- **📦 [Applications Documentation](#-applications-documentation)** - All AITBC apps and services documentation
- **🔧 [CLI Documentation](#cli-documentation)** - Command-line interface reference and usage
- **🏠 [Main Documentation](#-main-documentation)**
- **📖 [About Documentation](#-about-documentation)**
- **🗂️ [Archive & History](#-archive--history)**
- **✅ [Completed Projects](#-completed-projects)**
- **🔗 [External Documentation](#-external-documentation)**
- **🎯 [Topic-Specific Areas](#-topic-specific-areas)**
- **📋 [Releases](#-releases)** - Release notes and version history
---
## 📦 **Applications Documentation**
### **🎯 [Apps Overview](apps/README.md)**
**Complete documentation for all AITBC applications and services**
#### **Blockchain**
- [Blockchain Node](apps/blockchain/blockchain-node.md) - Production-ready blockchain node with PoA consensus
- [Blockchain Event Bridge](apps/blockchain/blockchain-event-bridge.md) - Event bridge for blockchain events
- [Blockchain Explorer](apps/blockchain/blockchain-explorer.md) - Blockchain explorer and analytics
#### **Coordinator**
- [Coordinator API](apps/coordinator/coordinator-api.md) - Job coordination service
- [Agent Coordinator](apps/coordinator/agent-coordinator.md) - Agent coordination and management
#### **Agents**
- [Agent Services](apps/agents/agent-services.md) - Agent bridge, compliance, protocols, registry, and trading
- [AI Engine](apps/agents/ai-engine.md) - AI engine for autonomous agent operations
#### **Exchange**
- [Exchange](apps/exchange/exchange.md) - Cross-chain exchange and trading platform
- [Exchange Integration](apps/exchange/exchange-integration.md) - Exchange integration services
- [Trading Engine](apps/exchange/trading-engine.md) - Trading engine for order matching
#### **Marketplace**
- [Marketplace](apps/marketplace/marketplace.md) - GPU marketplace for compute resources
- [Pool Hub](apps/marketplace/pool-hub.md) - Pool hub for resource pooling
#### **Wallet**
- [Wallet](apps/wallet/wallet.md) - Multi-chain wallet services
#### **Infrastructure**
- [Monitor](apps/infrastructure/monitor.md) - System monitoring and alerting
- [Multi-Region Load Balancer](apps/infrastructure/multi-region-load-balancer.md) - Load balancing across regions
- [Global Infrastructure](apps/infrastructure/global-infrastructure.md) - Global infrastructure management
#### **Plugins**
- [Plugin Analytics](apps/plugins/plugin-analytics.md) - Analytics plugin
- [Plugin Marketplace](apps/plugins/plugin-marketplace.md) - Marketplace plugin
- [Plugin Registry](apps/plugins/plugin-registry.md) - Plugin registry
- [Plugin Security](apps/plugins/plugin-security.md) - Security plugin
#### **Crypto**
- [ZK Circuits](apps/crypto/zk-circuits.md) - Zero-knowledge circuits for privacy
#### **Compliance**
- [Compliance Service](apps/compliance/compliance-service.md) - Compliance checking and regulatory services
#### **Mining**
- [Miner](apps/mining/miner.md) - Mining and block validation services
#### **Global AI**
- [Global AI Agents](apps/global-ai/global-ai-agents.md) - Global AI agent coordination
#### **Explorer**
- [Simple Explorer](apps/explorer/simple-explorer.md) - Simple blockchain explorer
---
## 🔧 **CLI Documentation**
### **🎯 [CLI Overview](project/cli/CLI_DOCUMENTATION.md)**
**Complete command-line interface documentation**
| Section | Description |
|---------|-------------|
| [CLI Architecture](project/cli/CLI_DOCUMENTATION.md#architecture) | CLI structure and design |
| [Command Groups](project/cli/CLI_DOCUMENTATION.md#command-groups) | Available command categories |
| [Usage Examples](project/cli/CLI_DOCUMENTATION.md#usage-examples) | Common CLI operations |
| [Configuration](project/cli/CLI_DOCUMENTATION.md#configuration) | CLI setup and config files |
---
## 📋 **Releases**
### **🎯 [Release Notes](releases/)**
**Complete release history and version information**
| Version | Date | Status | Key Features |
|---------|------|--------|--------------|
| [v0.3.2](releases/RELEASE_v0.3.2.md) | April 23, 2026 | ✅ Stable | Test infrastructure, CLI refactoring, CI/CD standardization |
| [v0.3.1](releases/RELEASE_v0.3.1.md) | April 13, 2026 | ✅ Stable | Milestone tracking fix, test cleanup |
| [v0.3.0](releases/RELEASE_v0.3.0.md) | March 30, 2026 | ✅ Stable | Multi-node sync, consensus improvements |
| [v0.2.5](releases/RELEASE_v0.2.5.md) | March 30, 2026 | ✅ Stable | Enhanced monitoring, security hardening |
| [v0.2.4](releases/RELEASE_v0.2.4.md) | March 15, 2026 | ✅ Stable | Exchange integration, marketplace improvements |
| [v0.2.3](releases/RELEASE_v0.2.3.md) | March 1, 2026 | ✅ Stable | Initial production release |
---
## 🏠 **Main Documentation**
### **📚 [Documentation Home](README.md)**
- **🎯 Purpose**: Main entry point and overview
- **📊 Content**: Project status, navigation guide, organization
- **🔗 Links**: All documentation sections and external resources
### **📖 [About Documentation](about/)**
Documentation about the documentation system itself:
| File | Purpose |
|------|---------|
| [📊 Organization Analysis](about/DOCS_ORGANIZATION_ANALYSIS.md) | Structure analysis and quality assessment |
| [🎯 10/10 Roadmap](about/DOCS_10_10_ROADMAP.md) | Path to perfect documentation quality |
| [🗂️ Archive Structure Fix](about/ARCHIVE_STRUCTURE_FIX.md) | Archive reorganization documentation |
| [📚 Centralization Guide](about/CENTRALIZED_DOCS_STRUCTURE.md) | Documentation centralization process |
| [📋 Sorting Summary](about/DOCUMENTATION_SORTING_SUMMARY.md) | Documentation sorting and organization |
### **🤖 [Agent SDK Documentation](agent-sdk/)**
**Complete documentation for OpenClaw agent communication:**
| File | Purpose |
|------|---------|
| [📱 Agent Communication Guide](agent-sdk/AGENT_COMMUNICATION_GUIDE.md) | Comprehensive agent communication guide |
| [🚀 Quick Start Guide](agent-sdk/QUICK_START_GUIDE.md) | Get started in 5 minutes |
| [📚 API Reference](agent-sdk/API_REFERENCE.md) | Complete API documentation |
---
## 🗂️ **Archive & History**
### **📚 [Archive Documentation](archive/README.md)**
**65 historical documents** organized in 7 categories:
| Category | Files | Content |
|----------|-------|---------|
| [📊 Analytics](archive/analytics/) | 6 files | AI agent communication analysis |
| [🔧 Backend](archive/backend/) | 3 files | Backend system documentation |
| [💻 CLI](archive/cli/) | 16 files | CLI implementation and testing |
| [📋 Core Planning](archive/core_planning/) | 5 files | Planning and requirements |
| [📚 General](archive/general/) | 16 files | General project documentation |
| [🏗️ Infrastructure](archive/infrastructure/) | 10 files | Infrastructure and deployment |
| [🔒 Security](archive/security/) | 7 files | Security and compliance |
---
## ✅ **Completed Projects**
### **📋 [Completed Projects](completed/README.md)**
**Project tracking and completion documentation:**
| Category | Focus | Status |
|----------|-------|--------|
| [🔧 Backend](completed/backend/) | Backend implementations | Production-ready |
| [💻 CLI](completed/cli/) | CLI enhancements | Integrated |
| [📋 Core Planning](completed/core_planning/) | Architecture work | Implemented |
| [🏗️ Infrastructure](completed/infrastructure/) | Infrastructure projects | Operational |
| [🔒 Security](completed/security/) | Security initiatives | Deployed |
| [📊 Summaries](completed/summaries/) | Project overviews | Documentation complete |
| [🛠️ Maintenance](completed/maintenance/) | System improvements | Validated |
---
## 🔗 **External Documentation (Symlinks)**
### **📚 Centralized External Access**
All external documentation accessible from main docs directory:
| Link | Target | Content |
|------|--------|---------|
| [💻 CLI Technical](cli-technical/) | `/cli/docs/` | CLI technical documentation |
| [📜 Contracts](contracts/) | `/contracts/docs/` | Smart contract documentation |
| [🧪 Testing](testing/) | `/tests/docs/` | Test documentation |
| [🌐 Website](website/) | `/website/docs/` | Website documentation |
| [⛓️ Blockchain Node](blockchain/node/) | `/apps/blockchain-node/docs/` | Blockchain node docs |
---
## 🎯 **Topic-Specific Areas**
### **📚 Subject-Specific Documentation**
| Area | Description | Status |
|------|-------------|--------|
| [🔒 Security](security/) | Security best practices and implementation | Active |
| [🏛️ Governance](governance/) | Governance and policy documentation | Active |
| [📋 Policies](policies/) | Project policies and procedures | Active |
| [🔧 Infrastructure](infrastructure/) | System infrastructure documentation | Active |
| [📊 Analytics](analytics/) | Data analytics and AI documentation | Active |
| [📱 Mobile](mobile/) | Mobile application documentation | Active |
| [🔄 Exchange](exchange/) | Exchange system documentation | Active |
| [🛠️ Development](development/) | Development workflow documentation | Active |
| [🚀 Deployment](deployment/) | Deployment guides and procedures | Active |
| [📝 Implementation](implementation/) | Implementation details and guides | Active |
| [🔧 Maintenance](maintenance/) | Maintenance procedures and guides | Active |
| [👥 Project](project/) | Project information and coordination | Active |
#### **📋 [Project Documentation](project/)**
**Core project documentation and implementation guides:**
| Category | Files | Content |
|----------|-------|---------|
| [🧠 AI Economics](project/ai-economics/) | 1 file | Advanced AI economics intelligence |
| [💻 CLI](project/cli/) | 1 file | Command-line interface documentation |
| [🏗️ Infrastructure](project/infrastructure/) | 4 files | System infrastructure and deployment |
| [📋 Requirements](project/requirements/) | 2 files | Project requirements and migration |
| [✅ Completion](project/completion/) | 1 file | 100% project completion summary |
| [🔧 Workspace](project/workspace/) | 1 file | Workspace strategy and organization |
| [📈 Summaries](summaries/) | Project summaries and reports | Active |
| [🔄 Workflows](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](README.md).
---
*Last updated: 2026-04-23*
Reference in New Issue View Git Blame Copy Permalink