docs: add code quality and type checking workflows to master index
Some checks failed
Documentation Validation / validate-docs (push) Has been cancelled
Python Tests / test-python (push) Has been cancelled
API Endpoint Tests / test-api-endpoints (push) Has been cancelled
CLI Tests / test-cli (push) Has been cancelled
Integration Tests / test-service-integration (push) Has been cancelled
Package Tests / test-python-packages (map[name:aitbc-agent-sdk path:packages/py/aitbc-agent-sdk]) (push) Has been cancelled
Package Tests / test-python-packages (map[name:aitbc-core path:packages/py/aitbc-core]) (push) Has been cancelled
Package Tests / test-python-packages (map[name:aitbc-crypto path:packages/py/aitbc-crypto]) (push) Has been cancelled
Package Tests / test-python-packages (map[name:aitbc-sdk path:packages/py/aitbc-sdk]) (push) Has been cancelled
Package Tests / test-javascript-packages (map[name:aitbc-sdk-js path:packages/js/aitbc-sdk]) (push) Has been cancelled
Package Tests / test-javascript-packages (map[name:aitbc-token path:packages/solidity/aitbc-token]) (push) Has been cancelled
Security Scanning / security-scan (push) Has been cancelled
Systemd Sync / sync-systemd (push) Has been cancelled

- Add Code Quality Module section with pre-commit hooks and quality checks
- Add Type Checking CI/CD Module section with MyPy workflow and coverage
- Update README with code quality achievements and project structure
- Migrate FastAPI apps from deprecated on_event to lifespan context manager
- Update pyproject.toml files to reference consolidated dependencies
- Remove unused app.py import in coordinator-api
- Add type hints to agent
This commit is contained in:
aitbc
2026-03-31 21:45:43 +02:00
parent 26592ddf55
commit 9db720add8
308 changed files with 34194 additions and 34575 deletions

View File

@@ -6,7 +6,7 @@ version: 1.0
# Multi-Node Blockchain Setup - Master Index
This master index provides navigation to all modules in the multi-node AITBC blockchain setup documentation. Each module focuses on specific aspects of the deployment and operation.
This master index provides navigation to all modules in the multi-node AITBC blockchain setup documentation and workflows. Each module focuses on specific aspects of the deployment, operation, and code quality.
## 📚 Module Overview
@@ -33,6 +33,62 @@ ssh aitbc1 '/opt/aitbc/scripts/workflow/03_follower_node_setup.sh'
---
### 🔧 Code Quality Module
**File**: `code-quality.md`
**Purpose**: Comprehensive code quality assurance workflow
**Audience**: Developers, DevOps engineers
**Prerequisites**: Development environment setup
**Key Topics**:
- Pre-commit hooks configuration
- Code formatting (Black, isort)
- Linting and type checking (Flake8, MyPy)
- Security scanning (Bandit, Safety)
- Automated testing integration
- Quality metrics and reporting
**Quick Start**:
```bash
# Install pre-commit hooks
./venv/bin/pre-commit install
# Run all quality checks
./venv/bin/pre-commit run --all-files
# Check type coverage
./scripts/type-checking/check-coverage.sh
```
---
### 🔧 Type Checking CI/CD Module
**File**: `type-checking-ci-cd.md`
**Purpose**: Comprehensive type checking workflow with CI/CD integration
**Audience**: Developers, DevOps engineers, QA engineers
**Prerequisites**: Development environment setup, basic Git knowledge
**Key Topics**:
- Local development type checking workflow
- Pre-commit hooks integration
- GitHub Actions CI/CD pipeline
- Coverage reporting and analysis
- Quality gates and enforcement
- Progressive type safety implementation
**Quick Start**:
```bash
# Local type checking
./venv/bin/mypy --ignore-missing-imports apps/coordinator-api/src/app/domain/
# Coverage analysis
./scripts/type-checking/check-coverage.sh
# Pre-commit hooks
./venv/bin/pre-commit run mypy-domain-core
```
---
### 🔧 Operations Module
**File**: `multi-node-blockchain-operations.md`
**Purpose**: Daily operations, monitoring, and troubleshooting