From b6d9fa8a11537bad539a0e91933ac5d52a80fe97 Mon Sep 17 00:00:00 2001 From: aitbc1 Date: Thu, 26 Mar 2026 17:42:51 +0100 Subject: [PATCH] fix: resolve CLI documentation duplication between beginner and technical docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- docs/CENTRALIZED_DOCS_STRUCTURE.md | 28 ++++++++++++++++++++-------- docs/{cli => cli-technical} | 0 2 files changed, 20 insertions(+), 8 deletions(-) rename docs/{cli => cli-technical} (100%) diff --git a/docs/CENTRALIZED_DOCS_STRUCTURE.md b/docs/CENTRALIZED_DOCS_STRUCTURE.md index d981f484..3a59681d 100644 --- a/docs/CENTRALIZED_DOCS_STRUCTURE.md +++ b/docs/CENTRALIZED_DOCS_STRUCTURE.md @@ -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` diff --git a/docs/cli b/docs/cli-technical similarity index 100% rename from docs/cli rename to docs/cli-technical