chore: remove outdated documentation and reference files
Some checks failed
AITBC CI/CD Pipeline / lint-and-test (3.11) (push) Has been cancelled
AITBC CI/CD Pipeline / lint-and-test (3.12) (push) Has been cancelled
AITBC CI/CD Pipeline / lint-and-test (3.13) (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
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
AITBC CLI Level 1 Commands Test / test-cli-level1 (3.11) (push) Has been cancelled
AITBC CLI Level 1 Commands Test / test-cli-level1 (3.12) (push) Has been cancelled
AITBC CLI Level 1 Commands Test / test-cli-level1 (3.13) (push) Has been cancelled
AITBC CLI Level 1 Commands Test / test-summary (push) Has been cancelled
Some checks failed
AITBC CI/CD Pipeline / lint-and-test (3.11) (push) Has been cancelled
AITBC CI/CD Pipeline / lint-and-test (3.12) (push) Has been cancelled
AITBC CI/CD Pipeline / lint-and-test (3.13) (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
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
AITBC CLI Level 1 Commands Test / test-cli-level1 (3.11) (push) Has been cancelled
AITBC CLI Level 1 Commands Test / test-cli-level1 (3.12) (push) Has been cancelled
AITBC CLI Level 1 Commands Test / test-cli-level1 (3.13) (push) Has been cancelled
AITBC CLI Level 1 Commands Test / test-summary (push) Has been cancelled
- Remove debugging service documentation (DEBUgging_SERVICES.md) - Remove development logs policy and quick reference guides - Remove E2E test creation summary - Remove gift certificate example file - Remove GitHub pull summary documentation
This commit is contained in:
42
docs/development/DEBUgging_SERVICES.md
Normal file
42
docs/development/DEBUgging_SERVICES.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# Debugging Services — aitbc1
|
||||
|
||||
**Date:** 2026-03-13
|
||||
**Branch:** aitbc1/debug-services
|
||||
|
||||
## Status
|
||||
|
||||
- [x] Fixed CLI hardcoded paths; CLI now loads
|
||||
- [x] Committed robustness fixes to main (1feeadf)
|
||||
- [x] Patched systemd services to use /opt/aitbc paths
|
||||
- [x] Installed coordinator-api dependencies (torch, numpy, etc.)
|
||||
- [ ] Get coordinator-api running (DB migration issue)
|
||||
- [ ] Get wallet daemon running
|
||||
- [ ] Test wallet creation and chain genesis
|
||||
- [ ] Set up P2P peering between aitbc and aitbc1
|
||||
|
||||
## Blockers
|
||||
|
||||
### Coordinator API startup fails
|
||||
```
|
||||
sqlalchemy.exc.OperationalError: index ix_users_email already exists
|
||||
```
|
||||
Root cause: migrations are not idempotent; existing DB has partial schema.
|
||||
Workaround: use a fresh DB file.
|
||||
|
||||
Also need to ensure .env has proper API key lengths and JSON array format.
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Clean coordinator.db, restart coordinator API successfully
|
||||
2. Start wallet daemon (simple_daemon.py)
|
||||
3. Use CLI to create wallet(s)
|
||||
4. Generate/use genesis_brother_chain_1773403269.yaml
|
||||
5. Start blockchain node on port 8005 (per Andreas) with that genesis
|
||||
6. Configure peers (aitbc at 10.1.223.93, aitbc1 at 10.1.223.40)
|
||||
7. Send test coins between wallets
|
||||
|
||||
## Notes
|
||||
|
||||
- Both hosts on same network (10.1.223.0/24)
|
||||
- Services should run as root (no sudo needed)
|
||||
- Ollama available on both for AI tests later
|
||||
53
docs/development/DEV_LOGS.md
Normal file
53
docs/development/DEV_LOGS.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Development Logs Policy
|
||||
|
||||
## 📁 Log Location
|
||||
All development logs should be stored in: `/opt/aitbc/dev/logs/`
|
||||
|
||||
## 🗂️ Directory Structure
|
||||
```
|
||||
dev/logs/
|
||||
├── archive/ # Old logs by date
|
||||
├── current/ # Current session logs
|
||||
├── tools/ # Download logs, wget logs, etc.
|
||||
├── cli/ # CLI operation logs
|
||||
├── services/ # Service-related logs
|
||||
└── temp/ # Temporary logs
|
||||
```
|
||||
|
||||
## 🛡️ Prevention Measures
|
||||
1. **Use log aliases**: `wgetlog`, `curllog`, `devlog`
|
||||
2. **Environment variables**: `$AITBC_DEV_LOGS_DIR`
|
||||
3. **Git ignore**: Prevents log files in project root
|
||||
4. **Cleanup scripts**: `cleanlogs`, `archivelogs`
|
||||
|
||||
## 🚀 Quick Commands
|
||||
```bash
|
||||
# Load log environment
|
||||
source /opt/aitbc/.env.dev
|
||||
|
||||
# Navigate to logs
|
||||
devlogs # Go to main logs directory
|
||||
currentlogs # Go to current session logs
|
||||
toolslogs # Go to tools logs
|
||||
clilogs # Go to CLI logs
|
||||
serviceslogs # Go to service logs
|
||||
|
||||
# Log operations
|
||||
wgetlog <url> # Download with proper logging
|
||||
curllog <url> # Curl with proper logging
|
||||
devlog "message" # Add dev log entry
|
||||
cleanlogs # Clean old logs
|
||||
archivelogs # Archive current logs
|
||||
|
||||
# View logs
|
||||
./dev/logs/view-logs.sh tools # View tools logs
|
||||
./dev/logs/view-logs.sh recent # View recent activity
|
||||
```
|
||||
|
||||
## 📋 Best Practices
|
||||
1. **Never** create log files in project root
|
||||
2. **Always** use proper log directories
|
||||
3. **Use** log aliases for common operations
|
||||
4. **Clean** up old logs regularly
|
||||
5. **Archive** important logs before cleanup
|
||||
|
||||
161
docs/development/DEV_LOGS_QUICK_REFERENCE.md
Normal file
161
docs/development/DEV_LOGS_QUICK_REFERENCE.md
Normal file
@@ -0,0 +1,161 @@
|
||||
# AITBC Development Logs - Quick Reference
|
||||
|
||||
## 🎯 **Problem Solved:**
|
||||
- ✅ **wget-log** moved from project root to `/opt/aitbc/dev/logs/tools/`
|
||||
- ✅ **Prevention measures** implemented to avoid future scattered logs
|
||||
- ✅ **Log organization system** established
|
||||
|
||||
## 📁 **New Log Structure:**
|
||||
```
|
||||
/opt/aitbc/dev/logs/
|
||||
├── archive/ # Old logs organized by date
|
||||
├── current/ # Current session logs
|
||||
├── tools/ # Download logs, wget logs, curl logs
|
||||
├── cli/ # CLI operation logs
|
||||
├── services/ # Service-related logs
|
||||
└── temp/ # Temporary logs
|
||||
```
|
||||
|
||||
## 🛡️ **Prevention Measures:**
|
||||
|
||||
### **1. Environment Configuration:**
|
||||
```bash
|
||||
# Load log environment (automatic in .env.dev)
|
||||
source /opt/aitbc/.env.dev.logs
|
||||
|
||||
# Environment variables available:
|
||||
$AITBC_DEV_LOGS_DIR # Main logs directory
|
||||
$AITBC_CURRENT_LOG_DIR # Current session logs
|
||||
$AITBC_TOOLS_LOG_DIR # Tools/download logs
|
||||
$AITBC_CLI_LOG_DIR # CLI operation logs
|
||||
$AITBC_SERVICES_LOG_DIR # Service logs
|
||||
```
|
||||
|
||||
### **2. Log Aliases:**
|
||||
```bash
|
||||
devlogs # cd to main logs directory
|
||||
currentlogs # cd to current session logs
|
||||
toolslogs # cd to tools logs
|
||||
clilogs # cd to CLI logs
|
||||
serviceslogs # cd to service logs
|
||||
|
||||
# Logging commands:
|
||||
wgetlog <url> # wget with proper logging
|
||||
curllog <url> # curl with proper logging
|
||||
devlog "message" # add dev log entry
|
||||
cleanlogs # clean old logs (>7 days)
|
||||
archivelogs # archive current logs (>1 day)
|
||||
```
|
||||
|
||||
### **3. Management Tools:**
|
||||
```bash
|
||||
# View logs
|
||||
./dev/logs/view-logs.sh tools # view tools logs
|
||||
./dev/logs/view-logs.sh current # view current logs
|
||||
./dev/logs/view-logs.sh recent # view recent activity
|
||||
|
||||
# Organize logs
|
||||
./dev/logs/organize-logs.sh # organize scattered logs
|
||||
|
||||
# Clean up logs
|
||||
./dev/logs/cleanup-logs.sh # cleanup old logs
|
||||
```
|
||||
|
||||
### **4. Git Protection:**
|
||||
```bash
|
||||
# .gitignore updated to prevent log files in project root:
|
||||
*.log
|
||||
*.out
|
||||
*.err
|
||||
wget-log
|
||||
download.log
|
||||
```
|
||||
|
||||
## 🚀 **Best Practices:**
|
||||
|
||||
### **DO:**
|
||||
✅ Use `wgetlog <url>` instead of `wget <url>`
|
||||
✅ Use `curllog <url>` instead of `curl <url>`
|
||||
✅ Use `devlog "message"` for development notes
|
||||
✅ Store all logs in `/opt/aitbc/dev/logs/`
|
||||
✅ Use log aliases for navigation
|
||||
✅ Clean up old logs regularly
|
||||
|
||||
### **DON'T:**
|
||||
❌ Create log files in project root
|
||||
❌ Use `wget` without `-o` option
|
||||
❌ Use `curl` without output redirection
|
||||
❌ Leave scattered log files
|
||||
❌ Ignore log organization
|
||||
|
||||
## 📋 **Quick Commands:**
|
||||
|
||||
### **For Downloads:**
|
||||
```bash
|
||||
# Instead of: wget http://example.com/file
|
||||
# Use: wgetlog http://example.com/file
|
||||
|
||||
# Instead of: curl http://example.com/api
|
||||
# Use: curllog http://example.com/api
|
||||
```
|
||||
|
||||
### **For Development:**
|
||||
```bash
|
||||
# Add development notes
|
||||
devlog "Fixed CLI permission issue"
|
||||
devlog "Added new exchange feature"
|
||||
|
||||
# Navigate to logs
|
||||
devlogs
|
||||
toolslogs
|
||||
clilogs
|
||||
```
|
||||
|
||||
### **For Maintenance:**
|
||||
```bash
|
||||
# Clean up old logs
|
||||
cleanlogs
|
||||
|
||||
# Archive current logs
|
||||
archivelogs
|
||||
|
||||
# View recent activity
|
||||
./dev/logs/view-logs.sh recent
|
||||
```
|
||||
|
||||
## 🎉 **Results:**
|
||||
|
||||
### **Before:**
|
||||
- ❌ `wget-log` in project root
|
||||
- ❌ Scattered log files everywhere
|
||||
- ❌ No organization system
|
||||
- ❌ No prevention measures
|
||||
|
||||
### **After:**
|
||||
- ✅ All logs organized in `/opt/aitbc/dev/logs/`
|
||||
- ✅ Proper directory structure
|
||||
- ✅ Prevention measures in place
|
||||
- ✅ Management tools available
|
||||
- ✅ Git protection enabled
|
||||
- ✅ Environment configured
|
||||
|
||||
## 🔧 **Implementation Status:**
|
||||
|
||||
| Component | Status | Details |
|
||||
|-----------|--------|---------|
|
||||
| **Log Organization** | ✅ COMPLETE | All logs moved to proper locations |
|
||||
| **Directory Structure** | ✅ COMPLETE | Hierarchical organization |
|
||||
| **Prevention Measures** | ✅ COMPLETE | Aliases, environment, git ignore |
|
||||
| **Management Tools** | ✅ COMPLETE | View, organize, cleanup scripts |
|
||||
| **Environment Config** | ✅ COMPLETE | Variables and aliases loaded |
|
||||
| **Git Protection** | ✅ COMPLETE | Root log files ignored |
|
||||
|
||||
## 🚀 **Future Prevention:**
|
||||
|
||||
1. **Automatic Environment**: Log aliases loaded automatically
|
||||
2. **Git Protection**: Log files in root automatically ignored
|
||||
3. **Cleanup Scripts**: Regular maintenance automated
|
||||
4. **Management Tools**: Easy organization and viewing
|
||||
5. **Documentation**: Clear guidelines and best practices
|
||||
|
||||
**🎯 The development logs are now properly organized and future scattered logs are prevented!**
|
||||
Reference in New Issue
Block a user