feat: implement modular workflow structure for multi-node blockchain

BREAKING CHANGE: Split 64KB monolithic workflow into 6 focused modules New Modular Structure: - MULTI_NODE_MASTER_INDEX.md: Central navigation hub for all modules - multi-node-blockchain-setup-core.md: Essential setup steps and basic configuration - multi-node-blockchain-operations.md: Daily operations, monitoring, troubleshooting - multi-node-blockchain-advanced.md: Smart contracts, security testing, performance optimization - multi-node-blockchain-production.md: Production deployment, security hardening, scaling - multi-node-blockchain-marketplace.md: Marketplace testing, GPU provider testing, AI operations - multi-node-blockchain-reference.md: Configuration reference, verification commands, best practices Benefits Achieved: ✅ Improved Maintainability: Each module focuses on specific functionality ✅ Enhanced Usability: Users can load only needed modules ✅ Better Documentation: Each module has focused troubleshooting guides ✅ Clear Dependencies: Explicit module relationships and learning paths ✅ Better Searchability: Find relevant information faster Migration Features: - Original 64KB workflow (2,098 lines) deprecated but preserved - Clear migration guide with section mapping - Master index provides navigation by task, role, and complexity - Cross-references between all modules - Quick start commands for each module Learning Paths: - New Users: Core → Operations → Reference - System Administrators: Core → Operations → Advanced → Reference - Production Engineers: Core → Operations → Advanced → Production → Reference - AI Engineers: Core → Operations → Advanced → Marketplace → Reference Technical Improvements: - Reduced file complexity from 2,098 lines to ~300 lines per module - Module-specific troubleshooting tables and command references - Focused prerequisite chains and dependency management - Production-ready configurations and security hardening - Comprehensive AI operations and marketplace testing Files: - New: 6 focused workflow modules + master index - Updated: Original monolithic workflow (deprecated with migration guide) - Preserved: All existing functionality in modular format - Added: Cross-references, learning paths, and quick navigation
2026-03-30 16:08:37 +02:00
parent bd1221ea5a
commit 3e1b651798
14 changed files with 4681 additions and 79 deletions
--- a/.windsurf/workflows/docs.md
+++ b/.windsurf/workflows/docs.md
@@ -0,0 +1,207 @@
+---
+description: Comprehensive documentation management and update workflow
+title: AITBC Documentation Management
+version: 2.0
+auto_execution_mode: 3
+---
+
+# AITBC Documentation Management Workflow
+
+This workflow manages and updates all AITBC project documentation, ensuring consistency and accuracy across the documentation ecosystem.
+
+## Priority Documentation Updates
+
+### High Priority Files
+```bash
+# Update core project documentation first
+docs/beginner/02_project/5_done.md
+docs/beginner/02_project/2_roadmap.md
+
+# Then update other key documentation
+docs/README.md
+docs/MASTER_INDEX.md
+docs/project/README.md
+docs/project/WORKING_SETUP.md
+```
+
+## Documentation Structure
+
+### Current Documentation Organization
+```
+docs/
+├── README.md                    # Main documentation entry point
+├── MASTER_INDEX.md              # Complete documentation index
+├── beginner/                    # Beginner-friendly documentation
+│   ├── 02_project/             # Project-specific docs
+│   │   ├── 2_roadmap.md       # Project roadmap
+│   │   └── 5_done.md           # Completed tasks
+│   ├── 06_github_resolution/   # GitHub integration
+│   └── ...                     # Other beginner docs
+├── project/                     # Project management docs
+│   ├── README.md               # Project overview
+│   ├── WORKING_SETUP.md        # Development setup
+│   └── ...                     # Other project docs
+├── infrastructure/              # Infrastructure documentation
+├── development/                 # Development guides
+├── summaries/                   # Documentation summaries
+└── ...                         # Other documentation categories
+```
+
+## Workflow Steps
+
+### 1. Update Priority Documentation
+```bash
+# Update completed tasks documentation
+cd /opt/aitbc
+echo "## Recent Updates" >> docs/beginner/02_project/5_done.md
+echo "- $(date): Updated project structure" >> docs/beginner/02_project/5_done.md
+
+# Update roadmap with current status
+echo "## Current Status" >> docs/beginner/02_project/2_roadmap.md
+echo "- Project consolidation completed" >> docs/beginner/02_project/2_roadmap.md
+```
+
+### 2. Update Core Documentation
+```bash
+# Update main README
+echo "## Latest Updates" >> docs/README.md
+echo "- Project consolidated to /opt/aitbc" >> docs/README.md
+
+# Update master index
+echo "## New Documentation" >> docs/MASTER_INDEX.md
+echo "- CLI enhancement documentation" >> docs/MASTER_INDEX.md
+```
+
+### 3. Update Technical Documentation
+```bash
+# Update infrastructure docs
+echo "## Service Configuration" >> docs/infrastructure/infrastructure.md
+echo "- Coordinator API: port 8000" >> docs/infrastructure/infrastructure.md
+echo "- Exchange API: port 8001" >> docs/infrastructure/infrastructure.md
+echo "- Blockchain RPC: port 8006" >> docs/infrastructure/infrastructure.md
+
+# Update development guides
+echo "## Environment Setup" >> docs/development/setup.md
+echo "source /opt/aitbc/venv/bin/activate" >> docs/development/setup.md
+```
+
+### 4. Generate Documentation Summaries
+```bash
+# Create summary of recent changes
+echo "# Documentation Update Summary - $(date)" > docs/summaries/latest_updates.md
+echo "## Key Changes" >> docs/summaries/latest_updates.md
+echo "- Project structure consolidation" >> docs/summaries/latest_updates.md
+echo "- CLI enhancement documentation" >> docs/summaries/latest_updates.md
+echo "- Service port updates" >> docs/summaries/latest_updates.md
+```
+
+### 5. Validate Documentation
+```bash
+# Check for broken links
+find docs/ -name "*.md" -exec grep -l "\[.*\](.*.md)" {} \;
+
+# Verify all referenced files exist
+find docs/ -name "*.md" -exec markdownlint {} \; 2>/dev/null || echo "markdownlint not available"
+
+# Check documentation consistency
+grep -r "aitbc-cli" docs/ | head -10
+```
+
+## Quick Documentation Commands
+
+### Update Specific Sections
+```bash
+# Update CLI documentation
+echo "## CLI Commands" >> docs/project/cli_reference.md
+echo "./aitbc-cli --help" >> docs/project/cli_reference.md
+
+# Update API documentation
+echo "## API Endpoints" >> docs/infrastructure/api_endpoints.md
+echo "- Coordinator: http://localhost:8000" >> docs/infrastructure/api_endpoints.md
+
+# Update service documentation
+echo "## Service Status" >> docs/infrastructure/services.md
+systemctl status aitbc-coordinator-api.service >> docs/infrastructure/services.md
+```
+
+### Generate Documentation Index
+```bash
+# Create comprehensive index
+echo "# AITBC Documentation Index" > docs/DOCUMENTATION_INDEX.md
+echo "Generated on: $(date)" >> docs/DOCUMENTATION_INDEX.md
+find docs/ -name "*.md" | sort | sed 's/docs\///' >> docs/DOCUMENTATION_INDEX.md
+```
+
+### Documentation Review
+```bash
+# Review recent documentation changes
+git log --oneline --since="1 week ago" -- docs/
+
+# Check documentation coverage
+find docs/ -name "*.md" | wc -l
+echo "Total markdown files: $(find docs/ -name "*.md" | wc -l)"
+
+# Find orphaned documentation
+find docs/ -name "*.md" -exec grep -L "README" {} \;
+```
+
+## Documentation Standards
+
+### Formatting Guidelines
+- Use standard markdown format
+- Include table of contents for long documents
+- Use proper heading hierarchy (##, ###, ####)
+- Include code blocks with language specification
+- Add proper links between related documents
+
+### Content Guidelines
+- Keep documentation up-to-date with code changes
+- Include examples and usage instructions
+- Document all configuration options
+- Include troubleshooting sections
+- Add contact information for support
+
+### File Organization
+- Use descriptive file names
+- Group related documentation in subdirectories
+- Keep main documentation in root docs/
+- Use consistent naming conventions
+- Include README.md in each subdirectory
+
+## Integration with Workflows
+
+### CI/CD Documentation Updates
+```bash
+# Update documentation after deployments
+echo "## Deployment Summary - $(date)" >> docs/deployments/latest.md
+echo "- Services updated" >> docs/deployments/latest.md
+echo "- Documentation synchronized" >> docs/deployments/latest.md
+```
+
+### Feature Documentation
+```bash
+# Document new features
+echo "## New Features - $(date)" >> docs/features/latest.md
+echo "- CLI enhancements" >> docs/features/latest.md
+echo "- Service improvements" >> docs/features/latest.md
+```
+
+## Recent Updates (v2.0)
+
+### Documentation Structure Updates
+- **Current Paths**: Updated to reflect `/opt/aitbc` structure
+- **Service Ports**: Updated API endpoint documentation
+- **CLI Integration**: Added CLI command documentation
+- **Project Consolidation**: Documented new project structure
+
+### Enhanced Workflow
+- **Priority System**: Added priority-based documentation updates
+- **Validation**: Added documentation validation steps
+- **Standards**: Added documentation standards and guidelines
+- **Integration**: Enhanced CI/CD integration
+
+### New Documentation Categories
+- **Summaries**: Added documentation summaries directory
+- **Infrastructure**: Enhanced infrastructure documentation
+- **Development**: Updated development guides
+- **CLI Reference**: Added CLI command reference