aitbc1
81ca33ff51
Some checks failed
AITBC CI/CD Pipeline / lint-and-test (3.13.5) (push) Has been cancelled
AITBC CI/CD Pipeline / test-cli (push) Has been cancelled
AITBC CI/CD Pipeline / test-services (push) Has been cancelled
AITBC CI/CD Pipeline / test-production-services (push) Has been cancelled
AITBC CI/CD Pipeline / security-scan (push) Has been cancelled
AITBC CI/CD Pipeline / build (push) Has been cancelled
AITBC CI/CD Pipeline / deploy-staging (push) Has been cancelled
AITBC CI/CD Pipeline / deploy-production (push) Has been cancelled
AITBC CI/CD Pipeline / performance-test (push) Has been cancelled
AITBC CI/CD Pipeline / docs (push) Has been cancelled
AITBC CI/CD Pipeline / release (push) Has been cancelled
AITBC CI/CD Pipeline / notify (push) Has been cancelled
GPU Benchmark CI / gpu-benchmark (3.13.5) (push) Has been cancelled
Security Scanning / Bandit Security Scan (apps/coordinator-api/src) (push) Has been cancelled
Security Scanning / Bandit Security Scan (cli/aitbc_cli) (push) Has been cancelled
Security Scanning / Bandit Security Scan (packages/py/aitbc-core/src) (push) Has been cancelled
Security Scanning / Bandit Security Scan (packages/py/aitbc-crypto/src) (push) Has been cancelled
Security Scanning / Bandit Security Scan (packages/py/aitbc-sdk/src) (push) Has been cancelled
Security Scanning / Bandit Security Scan (tests) (push) Has been cancelled
Security Scanning / CodeQL Security Analysis (javascript) (push) Has been cancelled
Security Scanning / CodeQL Security Analysis (python) (push) Has been cancelled
Security Scanning / Dependency Security Scan (push) Has been cancelled
Security Scanning / Container Security Scan (push) Has been cancelled
Security Scanning / OSSF Scorecard (push) Has been cancelled
Security Scanning / Security Summary Report (push) Has been cancelled
CENTRALIZATION COMPLETED: - Created symlinks from scattered docs folders to central /docs location - All documentation now accessible from single entry point - Maintained original file locations while providing centralized access SYMLINKS CREATED: ✅ /docs/blockchain/node -> /apps/blockchain-node/docs - Content: SCHEMA.md (blockchain node schema) ✅ /docs/cli -> /cli/docs - Content: CLI documentation, cleanup analysis, organization summary ✅ /docs/contracts -> /contracts/docs - Content: ZK-VERIFICATION.md (zero-knowledge verification) ✅ /docs/testing -> /tests/docs - Content: Test documentation, refactoring status, usage guides ✅ /docs/website -> /website/docs - Content: HTML documentation for web interface BENEFITS: 🎯 Single entry point for all documentation 🔄 Live updates through symlinks (no duplication) 📁 Clean organization while preserving context 🚀 Easy navigation and access VERIFICATION: ✅ All symlinks tested and working ✅ Content accessible through central location ✅ Original locations preserved for editing ✅ No broken links or missing files STRUCTURE: /docs/ ├── blockchain/node/ # Blockchain node docs ├── cli/ # CLI documentation ├── contracts/ # Contracts documentation ├── testing/ # Test documentation ├── website/ # Website documentation └── [existing docs/] # Rest of docs structure STATUS: Complete - All documentation centralized successfully
113 lines
3.7 KiB
Markdown
113 lines
3.7 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 -> /opt/aitbc/cli/docs/ # Symlink to 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 Documentation**
|
|
- **Source**: `/opt/aitbc/cli/docs/`
|
|
- **Symlink**: `/opt/aitbc/docs/cli`
|
|
- **Content**:
|
|
- `README.md` - CLI 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/docs`
|
|
- ✅ `/docs/contracts` → `/contracts/docs`
|
|
- ✅ `/docs/testing` → `/tests/docs`
|
|
- ✅ `/docs/website` → `/website/docs`
|
|
|
|
---
|
|
|
|
*Last updated: 2026-03-26*
|
|
*Status: Successfully centralized all documentation*
|