chore: standardize configuration, logging, and error handling across blockchain node and coordinator API

- Add infrastructure.md and workflow files to .gitignore to prevent sensitive info leaks - Change blockchain node mempool backend default from memory to database for persistence - Refactor blockchain node logger with StructuredLogFormatter and AuditLogger (consistent with coordinator) - Add structured logging fields: service, module, function, line number - Unify coordinator config with Database
2026-02-13 22:39:43 +01:00
parent 0cbd2b507c
commit 06e48ef34b
196 changed files with 4660 additions and 20090 deletions
--- a/docs/README.md
+++ b/docs/README.md
@@ -0,0 +1,142 @@
+# AITBC Documentation
+
+**AI Training Blockchain - Decentralized GPU Computing Platform**
+
+Welcome to the AITBC documentation! This guide will help you navigate the documentation based on your role.
+
+## Quick Navigation
+
+### 👤 New Users - Start Here!
+
+Start with the **Getting Started** section to learn the basics:
+
+| Order | Topic | Description |
+|-------|-------|-------------|
+| 1 | [0_getting_started/1_intro.md](./0_getting_started/1_intro.md) | What is AITBC? |
+| 2 | [0_getting_started/2_installation.md](./0_getting_started/2_installation.md) | Install AITBC |
+| 3 | [0_getting_started/3_cli.md](./0_getting_started/3_cli.md) | Use the CLI |
+
+### 💻 Clients
+
+If you're a **client** looking to rent GPU computing power:
+
+| Order | Topic | Description |
+|-------|-------|-------------|
+| 1 | [2_clients/1_quick-start.md](./2_clients/1_quick-start.md) | Quick start guide |
+| 2 | [2_clients/2_job-submission.md](./2_clients/2_job-submission.md) | Submit compute jobs |
+| 3 | [2_clients/3_job-lifecycle.md](./2_clients/3_job-lifecycle.md) | Status, results, history, cancellation |
+| 4 | [2_clients/4_wallet.md](./2_clients/4_wallet.md) | Manage tokens |
+| 5 | [2_clients/5_pricing-billing.md](./2_clients/5_pricing-billing.md) | Costs & invoices |
+| 6 | [2_clients/6_api-reference.md](./2_clients/6_api-reference.md) | Client API reference |
+
+### ⛏️ Miners
+
+If you're a **miner** providing GPU resources:
+
+| Order | Topic | Description |
+|-------|-------|-------------|
+| 1 | [3_miners/1_quick-start.md](./3_miners/1_quick-start.md) | Quick start guide |
+| 2 | [3_miners/2_registration.md](./3_miners/2_registration.md) | Register your miner |
+| 3 | [3_miners/3_job-management.md](./3_miners/3_job-management.md) | Handle jobs |
+| 4 | [3_miners/4_earnings.md](./3_miners/4_earnings.md) | Track earnings |
+| 5 | [3_miners/5_gpu-setup.md](./3_miners/5_gpu-setup.md) | Configure GPUs |
+
+### 🔗 Node Operators
+
+If you're running a **blockchain node**:
+
+| Order | Topic | Description |
+|-------|-------|-------------|
+| 1 | [4_blockchain/1_quick-start.md](./4_blockchain/1_quick-start.md) | Quick start guide |
+| 2 | [4_blockchain/2_configuration.md](./4_blockchain/2_configuration.md) | Configure your node |
+| 3 | [4_blockchain/3_operations.md](./4_blockchain/3_operations.md) | Day-to-day operations |
+| 4 | [4_blockchain/4_consensus.md](./4_blockchain/4_consensus.md) | Consensus mechanism |
+| 5 | [4_blockchain/7_monitoring.md](./4_blockchain/7_monitoring.md) | Monitor your node |
+
+## Documentation Structure
+
+```
+docs/
+├── 0_getting_started/          # New users start here
+│   ├── 1_intro.md             # What is AITBC?
+│   ├── 2_installation.md      # Installation guide
+│   └── 3_cli.md               # CLI usage
+├── 1_project/                  # Project management
+│   ├── 1_files.md             # File reference
+│   ├── 2_roadmap.md           # Future plans
+│   ├── 3_currenttask.md       # Current task (gitignored)
+│   ├── 4_currentissue.md      # Current issue (gitignored)
+│   ├── 5_done.md              # Completed work
+│   └── 6_cross-site-sync-resolved.md
+├── 2_clients/                  # Client docs (beginner → advanced)
+│   ├── 0_readme.md            # Overview
+│   ├── 1_quick-start.md       # Get started
+│   ├── 2_job-submission.md    # Submit jobs
+│   ├── 3_job-lifecycle.md     # Status, results, history, cancel
+│   ├── 4_wallet.md            # Token management
+│   ├── 5_pricing-billing.md   # Costs & invoices
+│   └── 6_api-reference.md     # API reference
+├── 3_miners/                   # Miner docs (beginner → advanced)
+│   ├── 0_readme.md            # Overview
+│   ├── 1_quick-start.md  →  7_api-miner.md
+├── 4_blockchain/              # Node operator docs (beginner → advanced)
+│   ├── 0_readme.md            # Overview
+│   ├── 1_quick-start.md  →  10_api-blockchain.md
+├── 5_reference/               # Technical reference (17 files)
+│   ├── 0_index.md
+│   ├── 1_cli-reference.md  →  17_docs-gaps.md
+├── 6_architecture/            # Architecture + component deep-dives
+│   ├── 1_system-flow.md       # End-to-end flow
+│   ├── 2_components-overview.md
+│   ├── 3_coordinator-api.md   # Component docs
+│   ├── 4_blockchain-node.md
+│   ├── 5_marketplace-web.md
+│   ├── 6_trade-exchange.md
+│   ├── 7_wallet.md
+│   ├── 8_codebase-structure.md
+│   └── 9_full-technical-reference.md
+├── 7_deployment/              # Deployment & ops
+│   ├── 0_index.md
+│   ├── 1_remote-deployment-guide.md  →  6_beta-release-plan.md
+├── 8_development/             # Developer guides (17 files)
+│   ├── 0_index.md
+│   ├── 1_overview.md  →  17_windsurf-testing.md
+├── 9_security/                # Security docs
+│   ├── 1_security-cleanup-guide.md
+│   └── 2_security-architecture.md
+└── README.md                  # This navigation guide
+```
+
+## Common Tasks
+
+| Task | Documentation |
+|------|---------------|
+| Install AITBC | [0_getting_started/2_installation.md](./0_getting_started/2_installation.md) |
+| Submit a job | [2_clients/2_job-submission.md](./2_clients/2_job-submission.md) |
+| Register as miner | [3_miners/2_registration.md](./3_miners/2_registration.md) |
+| Set up a node | [4_blockchain/1_quick-start.md](./4_blockchain/1_quick-start.md) |
+| Check balance | [2_clients/4_wallet.md](./2_clients/4_wallet.md) |
+| Monitor node | [4_blockchain/7_monitoring.md](./4_blockchain/7_monitoring.md) |
+| Troubleshooting | [4_blockchain/8_troubleshooting.md](./4_blockchain/8_troubleshooting.md) |
+
+## Additional Resources
+
+| Resource | Description |
+|----------|-------------|
+| [README.md](../README.md) | Project overview |
+| [1_project/2_roadmap.md](./1_project/2_roadmap.md) | Development roadmap |
+| [infrastructure.md](./infrastructure.md) | Network topology |
+| [1_project/5_done.md](./1_project/5_done.md) | Completed features |
+| [GitHub](https://github.com/oib/AITBC) | Source code |
+
+## Support
+
+- **Issues**: [GitHub Issues](https://github.com/oib/AITBC/issues)
+- **Discord**: [Join our community](https://discord.gg/aitbc)
+- **Email**: support@aitbc.io
+
+---
+
+**Version**: 1.0.0  
+**Last Updated**: 2026-02-13  
+**Maintainers**: AITBC Development Team