19d415a235
Some checks failed
Blockchain Synchronization Verification / sync-verification (push) Failing after 3s
CLI Tests / test-cli (push) Failing after 3s
Cross-Chain Functionality Tests / test-cross-chain-sync (push) Successful in 2s
Cross-Chain Functionality Tests / test-cross-chain-transactions (push) Successful in 3s
Cross-Chain Functionality Tests / test-cross-chain-bridge (push) Has been skipped
Cross-Chain Functionality Tests / test-multi-chain-consensus (push) Successful in 2s
Cross-Chain Functionality Tests / aggregate-results (push) Has been skipped
Deploy to Testnet / deploy-testnet (push) Successful in 1m12s
Documentation Validation / validate-docs (push) Failing after 8s
Documentation Validation / validate-policies-strict (push) Successful in 3s
Integration Tests / test-service-integration (push) Successful in 2m6s
Multi-Chain Island Architecture Tests / test-multi-chain-island (push) Successful in 2s
Multi-Node Blockchain Health Monitoring / health-check (push) Failing after 4s
P2P Network Verification / p2p-verification (push) Successful in 4s
Package Tests / Python package - aitbc-agent-sdk (push) Successful in 32s
Package Tests / Python package - aitbc-core (push) Successful in 14s
Package Tests / Python package - aitbc-crypto (push) Successful in 12s
Package Tests / Python package - aitbc-sdk (push) Successful in 9s
Package Tests / JavaScript package - aitbc-sdk-js (push) Successful in 8s
Package Tests / JavaScript package - aitbc-token (push) Successful in 17s
Python Tests / test-python (push) Successful in 15s
Security Scanning / security-scan (push) Successful in 27s
Node Failover Simulation / failover-test (push) Successful in 7s
Multi-Node Stress Testing / stress-test (push) Successful in 6s
Cross-Node Transaction Testing / transaction-test (push) Successful in 4s
- Add SQLCipher encryption for ait-mainnet database with configurable flag - Add db_encryption_enabled and db_encryption_key_path config settings - Implement encryption key loading and PRAGMA key setup via connection events - Add shutdown_db function for proper database cleanup - Export middleware classes in aitbc/__init__.py - Fix import path in sync.py for settings - Remove duplicate agent documentation from docs
121 lines
4.0 KiB
Markdown
121 lines
4.0 KiB
Markdown
# Centralized Documentation Structure
|
|
|
|
**Created**: 2026-03-26
|
|
**Status**: All documentation folders centralized via symlinks
|
|
|
|
## 📁 Centralized Documentation Structure
|
|
|
|
All documentation is now accessible from the central `/docs` directory through symlinks:
|
|
|
|
```
|
|
/opt/aitbc/docs/
|
|
├── README.md # Main documentation index
|
|
├── blockchain/ # Blockchain documentation
|
|
│ ├── README.md # Blockchain docs overview
|
|
│ └── node -> /opt/aitbc/apps/blockchain-node/docs/ # Symlink to app docs
|
|
├── cli/ # CLI documentation
|
|
├── cli/ # CLI documentation
|
|
├── contracts -> /opt/aitbc/contracts/docs/ # Symlink to contracts docs
|
|
├── testing -> /opt/aitbc/tests/docs/ # Symlink to test documentation
|
|
├── website -> /opt/aitbc/website/docs/ # Symlink to website docs
|
|
└── [other existing docs directories...] # Existing docs structure
|
|
```
|
|
|
|
## 🔗 Symlink Details
|
|
|
|
### **Blockchain Node Documentation**
|
|
- **Source**: `/opt/aitbc/apps/blockchain-node/docs/`
|
|
- **Symlink**: `/opt/aitbc/docs/blockchain/node`
|
|
- **Content**: `SCHEMA.md` - Blockchain node schema documentation
|
|
|
|
### **CLI Beginner Documentation**
|
|
- **Location**: `/opt/aitbc/docs/cli/`
|
|
- **Content**:
|
|
- `README.md` - Comprehensive CLI guide for beginners
|
|
- `permission-setup.md` - CLI permission setup
|
|
- `testing.md` - CLI testing guide
|
|
|
|
### **CLI Technical Documentation**
|
|
- **Source**: `/opt/aitbc/cli/docs/`
|
|
- **Symlink**: `/opt/aitbc/docs/cli`
|
|
- **Content**:
|
|
- `README.md` - CLI technical documentation
|
|
- `DISABLED_COMMANDS_CLEANUP.md` - Cleanup analysis
|
|
- `FILE_ORGANIZATION_SUMMARY.md` - Organization summary
|
|
|
|
### **Contracts Documentation**
|
|
- **Source**: `/opt/aitbc/contracts/docs/`
|
|
- **Symlink**: `/opt/aitbc/docs/contracts`
|
|
- **Content**: `ZK-VERIFICATION.md` - Zero-knowledge verification docs
|
|
|
|
### **Testing Documentation**
|
|
- **Source**: `/opt/aitbc/tests/docs/`
|
|
- **Symlink**: `/opt/aitbc/docs/testing`
|
|
- **Content**:
|
|
- `README.md` - Testing overview
|
|
- `TEST_REFACTORING_COMPLETED.md` - Refactoring completion
|
|
- `USAGE_GUIDE.md` - Test usage guide
|
|
- `cli-test-updates-completed.md` - CLI test updates
|
|
- `test-integration-completed.md` - Integration test status
|
|
|
|
### **Website Documentation**
|
|
- **Source**: `/opt/aitbc/website/docs/`
|
|
- **Symlink**: `/opt/aitbc/docs/website`
|
|
- **Content**: HTML documentation files for web interface
|
|
|
|
## ✅ Benefits
|
|
|
|
### **🎯 Centralized Access**
|
|
- **Single entry point**: All docs accessible from `/docs`
|
|
- **Logical organization**: Docs grouped by category
|
|
- **Easy navigation**: Clear structure for finding documentation
|
|
|
|
### **🔄 Live Updates**
|
|
- **Symlinks**: Changes in source locations immediately reflected
|
|
- **No duplication**: Single source of truth for each documentation set
|
|
- **Automatic sync**: No manual copying required
|
|
|
|
### **📁 Clean Structure**
|
|
- **Maintained organization**: Original docs stay in their logical locations
|
|
- **Central access point**: `/docs` serves as documentation hub
|
|
- **Preserved context**: Docs remain with their respective components
|
|
|
|
## 🚀 Usage
|
|
|
|
### **Access Documentation:**
|
|
```bash
|
|
# Blockchain node docs
|
|
ls /opt/aitbc/docs/blockchain/node/
|
|
|
|
# CLI docs
|
|
ls /opt/aitbc/docs/cli/
|
|
|
|
# Contracts docs
|
|
ls /opt/aitbc/docs/contracts/
|
|
|
|
# Testing docs
|
|
ls /opt/aitbc/docs/testing/
|
|
|
|
# Website docs
|
|
ls /opt/aitbc/docs/website/
|
|
```
|
|
|
|
### **Update Documentation:**
|
|
- Edit files in their original locations
|
|
- Changes automatically appear through symlinks
|
|
- No need to update multiple copies
|
|
|
|
## 🎯 Verification
|
|
|
|
All symlinks have been tested and confirmed working:
|
|
- ✅ `/docs/blockchain/node` → `/apps/blockchain-node/docs`
|
|
- ✅ `/docs/cli/` - CLI documentation (merged from cli-technical)
|
|
- ✅ `/docs/contracts` → `/contracts/docs`
|
|
- ✅ `/docs/testing` → `/tests/docs`
|
|
- ✅ `/docs/website` → `/website/docs`
|
|
|
|
---
|
|
|
|
*Last updated: 2026-03-26*
|
|
*Status: Successfully centralized all documentation*
|