Files
aitbc/docs/MASTER_INDEX.md
aitbc 96088f4501
Some checks failed
API Endpoint Tests / test-api-endpoints (push) Successful in 46s
CLI Tests / test-cli (push) Failing after 2s
Documentation Validation / validate-docs (push) Failing after 9s
Documentation Validation / validate-policies-strict (push) Failing after 12s
Package Tests / Python package - aitbc-agent-sdk (push) Successful in 24s
Package Tests / Python package - aitbc-core (push) Successful in 19s
Package Tests / Python package - aitbc-crypto (push) Successful in 10s
Package Tests / Python package - aitbc-sdk (push) Successful in 16s
Package Tests / JavaScript package - aitbc-sdk-js (push) Successful in 5s
Package Tests / JavaScript package - aitbc-token (push) Successful in 10s
Production Tests / Production Integration Tests (push) Successful in 17s
Python Tests / test-python (push) Successful in 8s
Security Scanning / security-scan (push) Successful in 46s
Multi-Node Blockchain Health Monitoring / health-check (push) Failing after 3s
Integration Tests / test-service-integration (push) Failing after 11m28s
docs-validation: expand curated markdown scope to include all documentation hubs
Add all documentation subdirectories to the curated markdown linting targets, replacing the previous exclusion-based approach with comprehensive coverage. Update validation to check for required README files across all hubs and verify priority documentation metadata markers. Implement lazy loading for optional dependencies (numpy, redis, bcrypt, jwt, websockets) in agent-coordinator and related modules to improve startup
2026-04-27 11:57:36 +02:00

13 KiB

AITBC Documentation Master Index

Complete documentation catalog with quick access to all content

Last Updated: April 27, 2026


🧭 Quick Access Table of Contents

📚 Learning Paths

📁 Documentation Categories


📦 Applications Documentation

🎯 Apps Overview

Complete documentation for all AITBC applications and services

Blockchain

Coordinator

Agents

  • Agent Services - Agent bridge, compliance, protocols, registry, and trading
  • AI Engine - AI engine for autonomous agent operations

Exchange

Marketplace

Wallet

  • Wallet - Multi-chain wallet services

Infrastructure

Plugins

Crypto

Compliance

Mining

  • Miner - Mining and block validation services

Global AI

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
📖 About Index Overview of the documentation standards hub
Compliance Audit Current remediation checklist
📊 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

🤖 Agent Integration Assets

Canonical agent API spec and manifest bundle:

File Purpose
📘 Agent Index Landing page for the agent API spec and manifest assets
📄 Agent API Spec API contract for registry, marketplace, and swarm coordination
🧾 Agent Manifest Canonical agent types, prerequisites, and quick commands

🗂️ 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

📚 Centralized External Access

External documentation and symlink targets accessible from the main docs directory:

Link Target Content
💻 CLI Technical /cli/docs/ CLI technical documentation
🧪 Testing /tests/docs/ Test documentation
⛓️ Blockchain Node /apps/blockchain-node/docs/ Blockchain node docs

Contract, node, and website documentation now live in local docs indexes under contracts/, nodes/, and website/.


🎯 Topic-Specific Areas

📚 Subject-Specific Documentation

Area Description Status
📖 Guides Documentation authoring and usage guides Active
🔒 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
📜 Contracts ZK verification and smart contract documentation Active
🖧 Nodes Node operations notes and command references Active
📦 Packages Language-specific packages and SDKs Active
📖 Reference Compact lookup and reference docs Active
📋 Releases Release notes and version history Active
📊 Reports Status, quality, and completion reports Active
📑 Summaries Outcome summaries and handoffs Active
🧵 Trail Operational breadcrumbs and success notes Active
🧩 OpenClaw OpenClaw agent integration documentation Active
🌐 Website Rendered documentation site assets Active
🔄 Workflows Documentation workflow outcomes 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

See the Summaries and Workflows entries above for the current top-level navigation paths.


🎉 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-27