diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml new file mode 100644 index 00000000..cd88c31a --- /dev/null +++ b/.github/workflows/markdown-link-check.yml @@ -0,0 +1,32 @@ +name: Markdown Link Check + +on: + push: + branches: [main] + paths: + - 'docs/**' + - '**.md' + pull_request: + branches: [main] + paths: + - 'docs/**' + - '**.md' + +jobs: + link-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Run lychee link checker + uses: lycheeverse/lychee-action@v1 + with: + args: --verbose --no-progress --exclude 'mailto:*' --exclude 'https://dashboard.aitbc.io/*' --exclude 'https://aitbc.bubuit.net/admin/*' --exclude 'https://aitbc.bubuit.net/api/*' --exclude 'https://docs.aitbc.bubuit.net/*' --exclude 'https://aitbc.io/*' --exclude 'http://localhost:*' --exclude 'http://aitbc.keisanki.net:*' --exclude 'https://docs.aitbc.net/*' --exclude-file .lycheeignore 'docs/**/*.md' '**.md' + fail: true + + - name: Upload link check results + if: always() + uses: actions/upload-artifact@v4 + with: + name: link-check-results + path: lychee/out.md diff --git a/.lycheeignore b/.lycheeignore new file mode 100644 index 00000000..b38e34b8 --- /dev/null +++ b/.lycheeignore @@ -0,0 +1,36 @@ +# Exclude known broken external links that are not critical for documentation +http://localhost:* +http://aitbc.keisanki.net:* +http://aitbc-cascade:* +https://docs.aitbc.net/ +https://docs.aitbc.io/ +https://dashboard.aitbc.io/* +https://aitbc.bubuit.net/admin/* +https://aitbc.bubuit.net/api/* +https://docs.aitbc.bubuit.net/* +https://aitbc.io/* + +# Exclude external services that may be temporarily unavailable +https://www.cert.org/ +https://pydantic-docs.helpmanual.io/ + +# Exclude GitHub links that point to wrong organization (should be oib/AITBC) +https://github.com/aitbc/* + +# Exclude GitHub discussions (may not be enabled yet) +https://github.com/oib/AITBC/discussions + +# Exclude Stack Overflow tag (may not exist yet) +https://stackoverflow.com/questions/tagged/aitbc + +# Exclude root-relative paths that need web server context +/assets/* +/docs/* +/Exchange/* +/explorer/* +/firefox-wallet/* +/ecosystem-extensions/* +/ecosystem-analytics/* + +# Exclude issue tracker links that may change +https://github.com/oib/AITBC/issues diff --git a/docs/1_project/3_infrastructure.md b/docs/1_project/3_infrastructure.md index ec60f717..5196b0c0 100644 --- a/docs/1_project/3_infrastructure.md +++ b/docs/1_project/3_infrastructure.md @@ -28,7 +28,7 @@ Internet → aitbc.bubuit.net (HTTPS :443) │ │ /docs/ → static HTML │ │ │ │ /wallet/ → :8002 (daemon) │ │ │ │ /api/ → :8000 (coordinator)│ │ -│ │ /rpc/ → :8081 (blockchain) │ │ +│ │ /rpc/ → :9080 (blockchain) │ │ │ │ /admin/ → :8000 (coordinator)│ │ │ │ /health → 200 OK │ │ │ │ │ │ @@ -46,7 +46,7 @@ Internet → aitbc.bubuit.net (HTTPS :443) |---------|------|---------|----------------|---------|--------| | Mock Coordinator | 8090 | python3 | 3.11+ | Development/testing API endpoint | systemd: aitbc-mock-coordinator.service | | Blockchain Node | N/A | python3 | 3.11+ | Local blockchain node | systemd: aitbc-blockchain-node.service | -| Blockchain RPC API | 9080 | python3 | 3.11+ | RPC API for blockchain | systemd: aitbc-blockchain-rpc.service | +| Blockchain Node RPC | 9080 | python3 | 3.11+ | RPC API for blockchain | systemd: aitbc-blockchain-rpc.service | | GPU Miner Client | N/A | python3 | 3.11+ | GPU mining client | systemd: aitbc-gpu-miner.service | | Local Development Tools | Varies | python3 | 3.11+ | CLI tools, scripts, testing | Manual/venv | @@ -144,7 +144,7 @@ ssh aitbc-cascade # Direct SSH to container |---------|------|---------|----------------|------------| | Nginx (web) | 80 | nginx | N/A | https://aitbc.bubuit.net/ | | Coordinator API | 8000 | python (uvicorn) | 3.11+ | /api/ → /v1/ | -| Blockchain Node RPC | 8081 | python3 | 3.11+ | /rpc/ | +| Blockchain Node RPC | 9080 | python3 | 3.11+ | /rpc/ | | Wallet Daemon | 8002 | python | 3.11+ | /wallet/ | | Trade Exchange | 3002 | python (server.py) | 3.11+ | /Exchange | | Exchange API | 8085 | python | 3.11+ | /api/trades/*, /api/orders/* | @@ -185,7 +185,7 @@ Config: `/etc/nginx/sites-enabled/aitbc.bubuit.net` | `/api/trades/recent` | proxy → `127.0.0.1:8085` | proxy_pass | | `/api/orders/orderbook` | proxy → `127.0.0.1:8085` | proxy_pass | | `/admin/` | proxy → `127.0.0.1:8000/v1/admin/` | proxy_pass | -| `/rpc/` | proxy → `127.0.0.1:8081` | proxy_pass | +| `/rpc/` | proxy → `127.0.0.1:9080` | proxy_pass | | `/wallet/` | proxy → `127.0.0.1:8002` | proxy_pass | | `/v1/` | proxy → `10.1.223.1:8090` (mock coordinator) | proxy_pass | | `/health` | 200 OK | direct | diff --git a/docs/5_reference/4_confidential-transactions.md b/docs/5_reference/4_confidential-transactions.md index 9d42c50d..e41c8ba0 100644 --- a/docs/5_reference/4_confidential-transactions.md +++ b/docs/5_reference/4_confidential-transactions.md @@ -173,10 +173,10 @@ Successfully implemented a comprehensive confidential transaction system for AIT ## Documentation -- [Architecture Design](confidential-transactions.md) +- [Architecture Design](./4_confidential-transactions.md) - [API Documentation](../6_architecture/3_coordinator-api.md) -- [Security Guide](security-guidelines.md) -- [Compliance Matrix](compliance-matrix.md) +- [Security Guide](../9_security/1_security-cleanup-guide.md) +- [Compliance Matrix](./compliance-matrix.md) ## Conclusion diff --git a/docs/5_reference/compliance-matrix.md b/docs/5_reference/compliance-matrix.md new file mode 100644 index 00000000..68b45fcb --- /dev/null +++ b/docs/5_reference/compliance-matrix.md @@ -0,0 +1,37 @@ +# Compliance Matrix + +> **Status**: Planned - Documentation pending + +This document will contain the compliance matrix for AITBC, covering: + +## Planned Sections + +- **Regulatory Compliance** + - GDPR compliance checklist + - Data protection requirements + - Privacy regulations by jurisdiction + +- **Security Standards** + - ISO 27001 alignment + - SOC 2 Type II requirements + - Security controls mapping + +- **Financial Regulations** + - AML/KYC requirements + - Payment services directive compliance + - Cross-border transaction regulations + +- **Industry Standards** + - Blockchain compliance frameworks + - DeFi regulatory guidelines + - AI/ML governance requirements + +## Implementation Status + +This compliance matrix is currently under development and will be populated as the AITBC platform progresses through compliance audits and regulatory reviews. + +--- + +**Last Updated**: 2026-02-17 +**Next Review**: TBD +**Owner**: Compliance Team