fix: resolve CLI documentation duplication between beginner and technical docs
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
This commit is contained in:
2026-03-26 17:42:51 +01:00
parent 81ca33ff51
commit b6d9fa8a11
2 changed files with 20 additions and 8 deletions

View File

@@ -13,7 +13,8 @@ All documentation is now accessible from the central `/docs` directory through s
├── 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
├── 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
@@ -27,11 +28,18 @@ All documentation is now accessible from the central `/docs` directory through s
- **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`
### **CLI Beginner Documentation**
- **Location**: `/opt/aitbc/docs/beginner/05_cli/`
- **Content**:
- `README.md` - CLI documentation
- `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
@@ -79,8 +87,11 @@ All documentation is now accessible from the central `/docs` directory through s
# Blockchain node docs
ls /opt/aitbc/docs/blockchain/node/
# CLI docs
ls /opt/aitbc/docs/cli/
# 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/
@@ -101,7 +112,8 @@ ls /opt/aitbc/docs/website/
All symlinks have been tested and confirmed working:
-`/docs/blockchain/node``/apps/blockchain-node/docs`
-`/docs/cli``/cli/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`