docs: centralize all documentation via symlinks to /docs directory
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
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
This commit is contained in:
@@ -1,107 +0,0 @@
|
||||
# AITBC CLI Documentation
|
||||
|
||||
**Updated**: 2026-03-26
|
||||
**Status**: Active Development - CLI Design Principles Applied
|
||||
**Structure**: Consolidated and Organized
|
||||
|
||||
## 📁 Documentation Structure
|
||||
|
||||
### 🚀 [Main CLI Guide](README.md)
|
||||
- Installation and setup
|
||||
- Quick start guide
|
||||
- Command reference
|
||||
- Configuration
|
||||
|
||||
### 📚 [Implementation Documentation](implementation/)
|
||||
- [Agent Communication Implementation](implementation/AGENT_COMMUNICATION_IMPLEMENTATION_SUMMARY.md)
|
||||
- [Analytics Implementation](implementation/ANALYTICS_IMPLEMENTATION_SUMMARY.md)
|
||||
- [Deployment Implementation](implementation/DEPLOYMENT_IMPLEMENTATION_SUMMARY.md)
|
||||
- [Marketplace Implementation](implementation/MARKETPLACE_IMPLEMENTATION_SUMMARY.md)
|
||||
- [Multi-Chain Implementation](implementation/MULTICHAIN_IMPLEMENTATION_SUMMARY.md)
|
||||
|
||||
### 📊 [Analysis & Reports](analysis/)
|
||||
- [CLI Wallet Daemon Integration](analysis/CLI_WALLET_DAEMON_INTEGRATION_SUMMARY.md)
|
||||
- [Implementation Complete Summary](analysis/IMPLEMENTATION_COMPLETE_SUMMARY.md)
|
||||
- [Localhost Only Enforcement](analysis/LOCALHOST_ONLY_ENFORCEMENT_SUMMARY.md)
|
||||
- [Node Integration](analysis/NODE_INTEGRATION_SUMMARY.md)
|
||||
- [Wallet Chain Connection](analysis/WALLET_CHAIN_CONNECTION_SUMMARY.md)
|
||||
|
||||
### 🛠️ [Installation & Setup Guides](guides/)
|
||||
- [Quick Install Guide](guides/QUICK_INSTALL_GUIDE.md)
|
||||
- [Local Package README](guides/LOCAL_PACKAGE_README.md)
|
||||
- [CLI Test Results](guides/CLI_TEST_RESULTS.md)
|
||||
|
||||
### 🗃️ [Legacy Documentation](legacy/)
|
||||
Historical documentation from previous development phases. Retained for reference but may contain outdated information.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Installation
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/aitbc/aitbc.git
|
||||
cd aitbc/cli
|
||||
|
||||
# Install in development mode (flat structure)
|
||||
pip install -e .
|
||||
|
||||
# Or use the virtual environment
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### Basic Usage
|
||||
|
||||
```bash
|
||||
# Check CLI is working
|
||||
aitbc --help
|
||||
|
||||
# Set up API key
|
||||
export AITBC_API_KEY=your_api_key_here
|
||||
aitbc config set api_key your_api_key_here
|
||||
|
||||
# Check wallet balance
|
||||
aitbc wallet balance
|
||||
|
||||
# Submit a job
|
||||
aitbc client submit --prompt "Generate an image" --model llama2
|
||||
|
||||
# Check miner status
|
||||
aitbc miner status
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Recent Changes (2026-03-26)
|
||||
|
||||
### ✅ CLI Design Principles Applied
|
||||
- **Removed embedded servers** - CLI now controls services instead of hosting them
|
||||
- **Flattened directory structure** - Eliminated "box in a box" nesting
|
||||
- **Simplified HTTP clients** - Replaced async pools with basic calls
|
||||
- **Removed blocking loops** - Single status checks instead of infinite monitoring
|
||||
- **No auto-opening browsers** - Provides URLs for user control
|
||||
- **Removed system calls** - CLI provides instructions instead of executing
|
||||
|
||||
### 📁 Documentation Consolidation
|
||||
- **Merged** `/cli/docs` into `/docs/cli` for single source of truth
|
||||
- **Organized** into implementation, analysis, guides, and legacy sections
|
||||
- **Updated** installation instructions for flat structure
|
||||
- **Purged** duplicate and outdated documentation
|
||||
|
||||
---
|
||||
|
||||
## 🔗 Related Documentation
|
||||
|
||||
- [Main AITBC Documentation](../README.md)
|
||||
- [Project File Structure](../1_project/1_files.md)
|
||||
- [Development Roadmap](../1_project/2_roadmap.md)
|
||||
|
||||
---
|
||||
|
||||
*Last updated: 2026-03-26*
|
||||
*CLI Version: 0.2.0*
|
||||
*Python: 3.13.5+*
|
||||
Reference in New Issue
Block a user