Commit Graph

3 Commits

Author SHA1 Message Date
81ca33ff51 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
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
2026-03-26 17:36:18 +01:00
394ecb49b9 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
2026-03-26 09:15:03 +01:00
AITBC System
6cb51c270c docs(planning): clean up next milestone document and remove completion markers
- Remove excessive completion checkmarks and status markers throughout document
- Consolidate redundant sections on completed features
- Streamline executive summary and current status sections
- Focus content on upcoming quick wins and active tasks
- Remove duplicate phase completion listings
- Clean up success metrics and KPI sections
- Maintain essential planning information while reducing noise
2026-03-08 13:42:14 +01:00