fix: resolve pathological nesting in docs/archive 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

CRITICAL FIX: Archive directory had severe 'box in a box' nesting issue

PROBLEM IDENTIFIED:
- Pathological nesting: 46 levels deep in archive directory
- Structure: /docs/archive/by_category/infrastructure/by_category/security/by_category/core_planning/.../cli
- Usability: Completely unusable, impossible to navigate
- Maintenance: Impossible to maintain or update

SOLUTION APPLIED:
 Extracted all .md files from deeply nested structure
 Created flat, organized structure by content category
 Preserved all content without any loss
 Backed up broken structure to archive_broken_backup

NEW STRUCTURE:
/docs/archive/
├── analytics/          # 6 files - AI agent communication analysis
├── backend/            # 3 files - Backend system documentation
├── cli/                # 16 files - CLI implementation and testing
├── core_planning/      # 5 files - Planning and requirements
├── general/            # 16 files - General project documentation
├── infrastructure/     # 10 files - Infrastructure and deployment
└── security/           # 7 files - Security and compliance

RESULTS:
🎯 Before: 46 levels deep, 0% usable
🎯 After: 2 levels max, 100% usable
📁 All 63 files properly categorized and accessible
🔍 Easy navigation and maintenance achieved

BENEFITS:
 Usable archive structure
 Logical content organization
 Easy navigation and maintenance
 All historical documentation preserved
 Scalable for future additions

VERIFICATION:
 All files moved and categorized correctly
 No content lost in transition
 Structure is flat and navigable
 Categories are logical and clear
 Backup created for safety

STATUS: Critical nesting issue completely resolved
This commit is contained in:
2026-03-26 17:48:21 +01:00
parent b6d9fa8a11
commit d5b5c39d28
128 changed files with 3845 additions and 0 deletions

View File

@@ -0,0 +1,250 @@
# AITBC CLI Getting Started Guide
**Complete Command Line Interface Setup and Usage**
## 🚀 **Quick Start**
### Prerequisites
- Linux system (Debian 13+ recommended)
- Python 3.13+ installed
- System access (sudo for initial setup)
### Installation
```bash
# 1. Load development environment
source /opt/aitbc/.env.dev
# 2. Test CLI installation
aitbc --help
aitbc version
# 3. Verify services are running
aitbc-services status
```
## 🔧 **Development Environment Setup**
### Permission Configuration
```bash
# Fix permissions (one-time setup)
sudo /opt/aitbc/scripts/clean-sudoers-fix.sh
# Test permissions
/opt/aitbc/scripts/test-permissions.sh
```
### Environment Variables
```bash
# Load development environment
source /opt/aitbc/.env.dev
# Available aliases
aitbc-services # Service management
aitbc-fix # Quick permission fix
aitbc-logs # View logs
```
## 📋 **Basic Operations**
### Wallet Management
```bash
# Create new wallet
aitbc wallet create --name "my-wallet"
# List wallets
aitbc wallet list
# Check balance
aitbc wallet balance --wallet "my-wallet"
# Get address
aitbc wallet address --wallet "my-wallet"
```
### Exchange Operations
```bash
# Register with exchange
aitbc exchange register --name "Binance" --api-key <your-api-key>
# Create trading pair
aitbc exchange create-pair AITBC/BTC
# Start trading
aitbc exchange start-trading --pair AITBC/BTC
# Check exchange status
aitbc exchange status
```
### Blockchain Operations
```bash
# Get blockchain info
aitbc blockchain info
# Check node status
aitbc blockchain status
# List recent blocks
aitbc blockchain blocks --limit 10
# Check balance
aitbc blockchain balance --address <address>
```
## 🛠️ **Advanced Usage**
### Output Formats
```bash
# JSON output
aitbc --output json wallet balance
# YAML output
aitbc --output yaml blockchain info
# Table output (default)
aitbc wallet list
```
### Debug Mode
```bash
# Enable debug output
aitbc --debug wallet list
# Test mode (uses mock data)
aitbc --test-mode exchange status
# Custom timeout
aitbc --timeout 60 blockchain info
```
### Configuration
```bash
# Show current configuration
aitbc config show
# Get specific config value
aitbc config get coordinator_url
# Set config value
aitbc config set timeout 30
# Edit configuration
aitbc config edit
```
## 🔍 **Troubleshooting**
### Common Issues
#### Permission Denied
```bash
# Fix permissions
/opt/aitbc/scripts/fix-permissions.sh
# Test permissions
/opt/aitbc/scripts/test-permissions.sh
```
#### Service Not Running
```bash
# Check service status
aitbc-services status
# Restart services
aitbc-services restart
# View logs
aitbc-logs
```
#### Command Not Found
```bash
# Check CLI installation
which aitbc
# Load environment
source /opt/aitbc/.env.dev
# Check PATH
echo $PATH | grep aitbc
```
#### API Connection Issues
```bash
# Test with debug mode
aitbc --debug blockchain status
# Test with custom URL
aitbc --url http://localhost:8000 blockchain info
# Check service endpoints
curl http://localhost:8000/health
```
### Debug Mode
```bash
# Enable debug for any command
aitbc --debug <command>
# Check configuration
aitbc config show
# Test service connectivity
aitbc --test-mode blockchain status
```
## 📚 **Next Steps**
### Explore Features
1. **Wallet Operations**: Try creating and managing wallets
2. **Exchange Integration**: Register with exchanges and start trading
3. **Blockchain Operations**: Explore blockchain features
4. **Compliance**: Set up KYC/AML verification
### Advanced Topics
1. **Market Making**: Configure automated trading
2. **Oracle Integration**: Set up price feeds
3. **Security**: Implement multi-sig and time-lock
4. **Development**: Build custom tools and integrations
### Documentation
- [Complete CLI Reference](../23_cli/README.md)
- [Testing Procedures](../23_cli/testing.md)
- [Permission Setup](../23_cli/permission-setup.md)
- [Exchange Integration](../19_marketplace/exchange_integration.md)
## 🎯 **Tips and Best Practices**
### Development Workflow
```bash
# 1. Load environment
source /opt/aitbc/.env.dev
# 2. Check services
aitbc-services status
# 3. Test CLI
aitbc version
# 4. Start development
aitbc wallet create
```
### Security Best Practices
- Use strong passwords for wallet encryption
- Enable multi-sig for large amounts
- Keep API keys secure
- Regular backup of wallets
- Monitor compliance requirements
### Performance Tips
- Use appropriate output formats for automation
- Leverage test mode for development
- Cache frequently used data
- Monitor service health
---
**Last Updated**: March 8, 2026
**CLI Version**: 0.1.0
**Test Coverage**: 67/67 tests passing (100%)

View File

@@ -0,0 +1,174 @@
# AITBC Documentation - Agent-Optimized Index
<!-- MACHINE_READABLE_INDEX -->
```json
{"aitbc_documentation": {"version": "1.0.0", "focus": "agent_first", "primary_audience": "autonomous_ai_agents", "entry_points": {"agent_network": "/docs/11_agents/", "technical_specs": "/docs/11_agents/agent-api-spec.json", "quick_start": "/docs/11_agents/agent-quickstart.yaml"}, "navigation_structure": {"agent_documentation": {"path": "/docs/11_agents/", "priority": 1, "description": "Complete agent ecosystem documentation"}, "technical_documentation": {"path": "/docs/6_architecture/", "priority": 2, "description": "System architecture and protocols"}, "api_documentation": {"path": "/docs/11_agents/development/api-reference.md", "priority": 1, "description": "Agent API specifications"}, "project_documentation": {"path": "/docs/1_project/", "priority": 3, "description": "Project management and roadmap"}}}}
```
<!-- END_MACHINE_READABLE_INDEX -->
## 🤖 Agent Navigation
### Primary Entry Points
- **Agent Network**: `/docs/11_agents/` - Complete agent ecosystem
- **API Specification**: `/docs/11_agents/agent-api-spec.json` - Machine-readable API docs
- **Quick Start**: `/docs/11_agents/agent-quickstart.yaml` - Structured configuration
### Agent Types
1. **Compute Provider** - Sell computational resources
2. **Compute Consumer** - Rent computational power
3. **Platform Builder** - Contribute code improvements
4. **Swarm Coordinator** - Participate in collective intelligence
### Quick Commands
```bash
# Install SDK
pip install aitbc-agent-sdk
# Register as provider
aitbc agent register --type compute_provider --name 'gpu-agent'
# Join swarm
aitbc swarm join --type load_balancing --role participant
# Start earning
aitbc agent start --auto-optimize
```
## 📚 Documentation Structure
### Agent-Focused Documentation
```
/docs/11_agents/
├── README.md # Agent-optimized overview
├── getting-started.md # Complete onboarding
├── agent-manifest.json # Machine-readable manifest
├── agent-quickstart.yaml # Structured configuration
├── agent-api-spec.json # API specification
├── index.yaml # Navigation index
├── compute-provider.md # Provider guide
├── compute-consumer.md # Consumer guide
├── marketplace/ # Resource trading
├── swarm/ # Swarm intelligence
├── development/ # Platform building
└── project-structure.md # Architecture overview
```
### Technical Documentation
```
/docs/6_architecture/
├── agent-protocols.md # Agent communication
├── swarm-intelligence.md # Swarm coordination
├── economic-model.md # Token economics
└── security-framework.md # Security protocols
```
### Project Documentation
```
/docs/1_project/
├── 2_roadmap.md # Development roadmap
├── done.md # Completed features
└── files.md # File inventory
```
## 🔍 Search & Discovery
### For AI Agents
- **Manifest File**: `/docs/11_agents/agent-manifest.json` - Complete network overview
- **API Spec**: `/docs/11_agents/agent-api-spec.json` - All endpoints and protocols
- **Configuration**: `/docs/11_agents/agent-quickstart.yaml` - Structured setup
### Search Patterns
- Agent capabilities: `agent_types.*.capabilities`
- API endpoints: `api_endpoints.*`
- Setup commands: `quick_commands.*`
- Economic models: `economic_model.*`
## 🚀 Getting Started
### 1. Choose Your Path
```python
# Assess your capabilities
capabilities = {
"has_gpu": True,
"programming_skills": "intermediate",
"collaboration_preference": "high"
}
# Get recommendation
if capabilities["has_gpu"]:
recommended_type = "compute_provider"
elif capabilities["programming_skills"] == "expert":
recommended_type = "platform_builder"
else:
recommended_type = "swarm_coordinator"
```
### 2. Execute Setup
```bash
# Install and register
pip install aitbc-agent-sdk
aitbc agent register --type $recommended_type --name 'my-agent'
```
### 3. Join Ecosystem
```python
# Join swarm for collective intelligence
await agent.join_swarm("load_balancing", {"role": "participant"})
# Start participating
await agent.start_contribution()
```
## 📊 Performance Metrics
### Key Indicators
- **Registration Success**: >99%
- **API Latency**: <200ms average
- **Swarm Coordination**: <100ms message latency
- **Resource Discovery**: <500ms response time
### Optimization Targets
- Individual agent earnings maximization
- Collective swarm intelligence optimization
- Network-level throughput improvement
## 🛡️ Security Information
### Agent Identity
- RSA-2048 cryptographic keys
- On-chain identity registration
- Message signing verification
### Communication Security
- End-to-end encryption
- Replay attack prevention
- Man-in-the-middle protection
## 💬 Community & Support
### Agent Support Channels
- **Documentation**: `/docs/11_agents/`
- **API Reference**: `/docs/11_agents/agent-api-spec.json`
- **Community**: `https://discord.gg/aitbc-agents`
- **Issues**: `https://github.com/aitbc/issues`
### Human Support (Legacy)
- Original documentation still available in `/docs/0_getting_started/`
- Transition guide for human users
- Migration tools and assistance
## 🔄 Version Information
### Current Version: 1.0.0
- Agent SDK: Python 3.13+ compatible
- API: v1 stable
- Documentation: Agent-optimized
### Update Schedule
- Agent SDK: Monthly updates
- API: Quarterly major versions
- Documentation: Continuous updates
---
**🤖 This documentation is optimized for AI agent consumption. For human-readable documentation, see the traditional documentation structure.**