aitbc1
b6d9fa8a11
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
DUPLICATE RESOLVED: - Fixed confusion between /docs/beginner/05_cli/ and /docs/cli - Renamed symlink to clarify purpose and eliminate duplication CHANGES MADE: ✅ Removed: /docs/cli (symlink to /cli/docs) ✅ Created: /docs/cli-technical (symlink to /cli/docs) ✅ Updated: Documentation to reflect the change CLARIFIED STRUCTURE: /docs/beginner/05_cli/ # CLI beginner documentation (detailed guides) ├── README.md # Comprehensive CLI guide for beginners ├── permission-setup.md # CLI permission setup └── testing.md # CLI testing guide /docs/cli-technical -> /cli/docs # CLI technical documentation (symlink) ├── README.md # CLI technical documentation ├── DISABLED_COMMANDS_CLEANUP.md └── FILE_ORGANIZATION_SUMMARY.md BENEFITS: 🎯 Clear separation: Beginner guides vs technical implementation 📚 No confusion: Distinct naming for different purposes 🔍 Easy navigation: Obvious which docs to use for which need ✅ Preserved content: All documentation remains accessible VERIFICATION: ✅ Both documentation types accessible ✅ No broken links or missing files ✅ Clear naming convention established ✅ Documentation updated to reflect changes STATUS: Duplicate resolved - CLI docs now properly categorized
125 lines
4.2 KiB
Markdown
125 lines
4.2 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
|
|
├── beginner/05_cli/ # CLI beginner documentation (detailed guides)
|
|
├── cli-technical -> /opt/aitbc/cli/docs/ # Symlink to CLI technical docs
|
|
├── 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/beginner/05_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-technical`
|
|
- **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 beginner docs
|
|
ls /opt/aitbc/docs/beginner/05_cli/
|
|
|
|
# CLI technical docs
|
|
ls /opt/aitbc/docs/cli-technical/
|
|
|
|
# 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/beginner/05_cli/` → CLI beginner documentation (regular directory)
|
|
- ✅ `/docs/cli-technical` → `/cli/docs`
|
|
- ✅ `/docs/contracts` → `/contracts/docs`
|
|
- ✅ `/docs/testing` → `/tests/docs`
|
|
- ✅ `/docs/website` → `/website/docs`
|
|
|
|
---
|
|
|
|
*Last updated: 2026-03-26*
|
|
*Status: Successfully centralized all documentation*
|