docs: consolidate CLI documentation and purge legacy structure

MERGE OPERATIONS:
- Merged /opt/aitbc/cli/docs into /opt/aitbc/docs/cli
- Eliminated duplicate CLI documentation locations
- Created single source of truth for CLI docs

ORGANIZATION IMPROVEMENTS:
- Created structured subdirectories:
  • implementation/ - Core implementation summaries
  • analysis/ - Analysis reports and integration summaries
  • guides/ - Installation and setup guides
  • legacy/ - Historical documentation (archived)

- Updated main README.md with:
  • New consolidated structure overview
  • Updated installation instructions for flat CLI structure
  • Recent CLI design principles changes
  • Proper navigation to subdirectories

- Created legacy/README.md with:
  • Clear deprecation notice
  • File categorization
  • Purge candidates identification
  • Migration notes from old to new structure

FILE MOVES:
- 15 implementation summaries → implementation/
- 5 analysis reports → analysis/
- 3 setup guides → guides/
- 19 legacy documented files → legacy/
- 1 demonstration file → root (active reference)

PROJECT DOCUMENTATION UPDATES:
- Updated /docs/beginner/02_project/1_files.md
- Reflected flattened CLI structure (cli/commands/ vs cli/aitbc_cli/commands/)
- Added docs/cli/ as consolidated documentation location
- Updated Python version requirement to 3.13.5 only

BENEFITS:
- Single location for all CLI documentation
- Clear separation of current vs legacy information
- Better organization and discoverability
- Easier maintenance and updates
- Proper archival of historical documentation

STATUS:
 Consolidation complete
 Legacy properly archived
 Structure organized
 Documentation updated
This commit is contained in:
2026-03-26 09:15:03 +01:00
parent c0952c2525
commit 394ecb49b9
37 changed files with 188 additions and 43 deletions

View File

@@ -105,22 +105,23 @@ Last updated: 2026-03-25
| Path | Status | Notes |
|------|--------|-------|
| `cli/aitbc_cli/commands/client.py` | ✅ Active | Client CLI (submit, batch-submit, templates, history) |
| `cli/aitbc_cli/commands/miner.py` | ✅ Active | Miner CLI (register, earnings, capabilities, concurrent) |
| `cli/aitbc_cli/commands/wallet.py` | ✅ Active | Wallet CLI (balance, staking, multisig, backup/restore) |
| `cli/aitbc_cli/commands/auth.py` | ✅ Active | Auth CLI (login, tokens, API keys) |
| `cli/aitbc_cli/commands/blockchain.py` | ✅ Active | Blockchain queries |
| `cli/aitbc_cli/commands/marketplace.py` | ✅ Active | GPU marketplace operations |
| `cli/aitbc_cli/commands/admin.py` | ✅ Active | System administration, audit logging |
| `cli/aitbc_cli/commands/config.py` | ✅ Active | Configuration, profiles, encrypted secrets |
| `cli/aitbc_cli/commands/monitor.py` | ✅ Active | Dashboard, metrics, alerts, webhooks |
| `cli/aitbc_cli/commands/simulate.py` | ✅ Active | Test simulation framework |
| `cli/aitbc_cli/plugins.py` | ✅ Active | Plugin system for custom commands |
| `cli/aitbc_cli/main.py` | ✅ Active | CLI entry point (12 command groups) |
| `cli/commands/client.py` | ✅ Active | Client CLI (submit, batch-submit, templates, history) |
| `cli/commands/miner.py` | ✅ Active | Miner CLI (register, earnings, capabilities, concurrent) |
| `cli/commands/wallet.py` | ✅ Active | Wallet CLI (balance, staking, multisig, backup/restore) |
| `cli/commands/auth.py` | ✅ Active | Auth CLI (login, tokens, API keys) |
| `cli/commands/blockchain.py` | ✅ Active | Blockchain queries |
| `cli/commands/marketplace.py` | ✅ Active | GPU marketplace operations |
| `cli/commands/admin.py` | ✅ Active | System administration, audit logging |
| `cli/commands/config.py` | ✅ Active | Configuration, profiles, encrypted secrets |
| `cli/commands/monitor.py` | ✅ Active | Dashboard, metrics, alerts, webhooks |
| `cli/commands/simulate.py` | ✅ Active | Test simulation framework |
| `cli/plugins.py` | ✅ Active | Plugin system for custom commands |
| `cli/main.py` | ✅ Active | CLI entry point (flattened structure, Mar 2026) |
| `cli/man/aitbc.1` | ✅ Active | Man page |
| `cli/aitbc_shell_completion.sh` | ✅ Active | Shell completion script |
| `cli/test_ollama_gpu_provider.py` | ✅ Active | GPU testing |
| `.github/workflows/cli-tests.yml` | ✅ Active | CI/CD for CLI tests (Python 3.11/3.12/3.13) |
| `docs/cli/` | ✅ Active | Consolidated CLI documentation (Mar 2026) |
| `.github/workflows/cli-tests.yml` | ✅ Active | CI/CD for CLI tests (Python 3.13.5 only) |
### Home Scripts (`home/`)