# Master Documentation Index **Last Updated:** 2025-01-20 **Document Version:** 5.0 **Project:** Sankofa / Phoenix / PanTel ยท ChainID 138 ยท Proxmox + Cloudflare Zero Trust --- ## ๐Ÿ“‘ Table of Contents 1. [Quick Start](#-quick-start) 2. [Directory Structure](#-directory-structure) 3. [Core Architecture](#-core-architecture--design) 4. [Deployment Guides](#-deployment--operations) 5. [Configuration & Setup](#-configuration--setup) 6. [Network Infrastructure](#-network-infrastructure) 7. [Besu & Blockchain](#-besu--blockchain-operations) 8. [CCIP & Chainlink](#-ccip--chainlink) 9. [Monitoring & Observability](#-monitoring--observability) 10. [Troubleshooting](#-troubleshooting) 11. [Best Practices](#-best-practices--recommendations) 12. [Technical References](#-technical-references) 13. [Quick References](#-quick-references) --- ## ๐Ÿ“ Directory Structure ``` docs/ โ”œโ”€โ”€ MASTER_INDEX.md # This file - Complete index โ”œโ”€โ”€ README.md # Documentation overview โ”œโ”€โ”€ DOCUMENTATION_STYLE_GUIDE.md # Documentation style guide โ”œโ”€โ”€ DOCUMENTATION_REVIEW.md # Documentation review report โ”œโ”€โ”€ DOCUMENTATION_QUALITY_REVIEW.md # Quality review (duplicates, gaps, inconsistencies) โ”œโ”€โ”€ DOCUMENTATION_FIXES_COMPLETE.md # Documentation fixes implementation report โ”œโ”€โ”€ DOCUMENTATION_ENHANCEMENTS_RECOMMENDATIONS.md # Enhancement recommendations and visual elements โ”‚ โ”œโ”€โ”€ 01-getting-started/ # Getting started guides โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ README_START_HERE.md โ”‚ โ””โ”€โ”€ PREREQUISITES.md โ”‚ โ”œโ”€โ”€ 02-architecture/ # Core architecture & design โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ NETWORK_ARCHITECTURE.md โ”‚ โ”œโ”€โ”€ ORCHESTRATION_DEPLOYMENT_GUIDE.md โ”‚ โ”œโ”€โ”€ PHYSICAL_HARDWARE_INVENTORY.md โ”‚ โ”œโ”€โ”€ VMID_ALLOCATION_FINAL.md โ”‚ โ”œโ”€โ”€ DOMAIN_STRUCTURE.md โ”‚ โ””โ”€โ”€ HOSTNAME_MIGRATION_GUIDE.md โ”‚ โ”œโ”€โ”€ 03-deployment/ # Deployment & operations โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ OPERATIONAL_RUNBOOKS.md โ”‚ โ”œโ”€โ”€ VALIDATED_SET_DEPLOYMENT_GUIDE.md โ”‚ โ”œโ”€โ”€ DEPLOYMENT_STATUS_CONSOLIDATED.md โ”‚ โ”œโ”€โ”€ DEPLOYMENT_READINESS.md โ”‚ โ”œโ”€โ”€ RUN_DEPLOYMENT.md โ”‚ โ”œโ”€โ”€ REMOTE_DEPLOYMENT.md โ”‚ โ”œโ”€โ”€ DISASTER_RECOVERY.md โ”‚ โ”œโ”€โ”€ BACKUP_AND_RESTORE.md โ”‚ โ””โ”€โ”€ CHANGE_MANAGEMENT.md โ”‚ โ”œโ”€โ”€ 04-configuration/ # Configuration & setup โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ MCP_SETUP.md โ”‚ โ”œโ”€โ”€ ER605_ROUTER_CONFIGURATION.md โ”‚ โ”œโ”€โ”€ OMADA_API_SETUP.md โ”‚ โ”œโ”€โ”€ OMADA_HARDWARE_CONFIGURATION_REVIEW.md โ”‚ โ”œโ”€โ”€ cloudflare/ # Cloudflare configuration โ”‚ โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”‚ โ”œโ”€โ”€ CLOUDFLARE_ZERO_TRUST_GUIDE.md โ”‚ โ”‚ โ”œโ”€โ”€ CLOUDFLARE_DNS_TO_CONTAINERS.md โ”‚ โ”‚ โ”œโ”€โ”€ CLOUDFLARE_DNS_SPECIFIC_SERVICES.md โ”‚ โ”‚ โ”œโ”€โ”€ CLOUDFLARE_TUNNEL_CONFIGURATION_GUIDE.md โ”‚ โ”‚ โ”œโ”€โ”€ CLOUDFLARE_TUNNEL_INSTALLATION.md โ”‚ โ”‚ โ”œโ”€โ”€ CLOUDFLARE_TUNNEL_QUICK_SETUP.md โ”‚ โ”‚ โ”œโ”€โ”€ CLOUDFLARE_TUNNEL_RPC_SETUP.md โ”‚ โ”‚ โ”œโ”€โ”€ CLOUDFLARE_EXPLORER_CONFIG.md โ”‚ โ”‚ โ””โ”€โ”€ CLOUDFLARE_EXPLORER_QUICK_SETUP.md โ”‚ โ”œโ”€โ”€ SECRETS_KEYS_CONFIGURATION.md โ”‚ โ”œโ”€โ”€ ENV_STANDARDIZATION.md โ”‚ โ”œโ”€โ”€ CREDENTIALS_CONFIGURED.md โ”‚ โ”œโ”€โ”€ SSH_SETUP.md โ”‚ โ””โ”€โ”€ FINALIZE_TOKEN.md โ”‚ โ”œโ”€โ”€ 05-network/ # Network infrastructure โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ NETWORK_STATUS.md โ”‚ โ”œโ”€โ”€ NGINX_ARCHITECTURE_RPC.md โ”‚ โ”œโ”€โ”€ CLOUDFLARE_NGINX_INTEGRATION.md โ”‚ โ”œโ”€โ”€ RPC_NODE_TYPES_ARCHITECTURE.md โ”‚ โ””โ”€โ”€ RPC_TEMPLATE_TYPES.md โ”‚ โ”œโ”€โ”€ 06-besu/ # Besu & blockchain โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ BESU_ALLOWLIST_RUNBOOK.md โ”‚ โ”œโ”€โ”€ BESU_ALLOWLIST_QUICK_START.md โ”‚ โ”œโ”€โ”€ BESU_NODES_FILE_REFERENCE.md โ”‚ โ”œโ”€โ”€ BESU_OFFICIAL_REFERENCE.md โ”‚ โ”œโ”€โ”€ BESU_OFFICIAL_UPDATES.md โ”‚ โ”œโ”€โ”€ QUORUM_GENESIS_TOOL_REVIEW.md โ”‚ โ”œโ”€โ”€ VALIDATOR_KEY_DETAILS.md โ”‚ โ””โ”€โ”€ COMPREHENSIVE_CONSISTENCY_REVIEW.md โ”‚ โ”œโ”€โ”€ 07-ccip/ # CCIP & Chainlink โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ””โ”€โ”€ CCIP_DEPLOYMENT_SPEC.md โ”‚ โ”œโ”€โ”€ 08-monitoring/ # Monitoring & observability โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ MONITORING_SUMMARY.md โ”‚ โ””โ”€โ”€ BLOCK_PRODUCTION_MONITORING.md โ”‚ โ”œโ”€โ”€ 09-troubleshooting/ # Troubleshooting โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ TROUBLESHOOTING_FAQ.md โ”‚ โ”œโ”€โ”€ QBFT_TROUBLESHOOTING.md โ”‚ โ””โ”€โ”€ SECURITY_INCIDENT_RESPONSE.md โ”‚ โ”œโ”€โ”€ 10-best-practices/ # Best practices โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ RECOMMENDATIONS_AND_SUGGESTIONS.md โ”‚ โ”œโ”€โ”€ IMPLEMENTATION_CHECKLIST.md โ”‚ โ”œโ”€โ”€ BEST_PRACTICES_SUMMARY.md โ”‚ โ”œโ”€โ”€ QUICK_WINS.md โ”‚ โ””โ”€โ”€ PERFORMANCE_TUNING.md โ”‚ โ”œโ”€โ”€ 11-references/ # Technical references โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ APT_PACKAGES_CHECKLIST.md โ”‚ โ”œโ”€โ”€ PATHS_REFERENCE.md โ”‚ โ”œโ”€โ”€ SCRIPT_REVIEW.md โ”‚ โ””โ”€โ”€ TEMPLATE_BASE_WORKFLOW.md โ”‚ โ”œโ”€โ”€ 12-quick-reference/ # Quick references โ”‚ โ”œโ”€โ”€ README.md โ”‚ โ”œโ”€โ”€ QUICK_REFERENCE.md โ”‚ โ”œโ”€โ”€ VALIDATED_SET_QUICK_REFERENCE.md โ”‚ โ””โ”€โ”€ QUICK_START_TEMPLATE.md โ”‚ โ””โ”€โ”€ archive/ # Historical documents โ””โ”€โ”€ README.md ``` --- ## ๐Ÿš€ Quick Start ### First Time Setup | Step | Document | Description | |------|----------|-------------| | 1 | **[01-getting-started/README_START_HERE.md](01-getting-started/README_START_HERE.md)** | Complete getting started guide - **START HERE** | | 2 | **[01-getting-started/PREREQUISITES.md](01-getting-started/PREREQUISITES.md)** | System requirements and prerequisites | | 3 | **[04-configuration/MCP_SETUP.md](04-configuration/MCP_SETUP.md)** | MCP Server configuration for Claude Desktop | | 4 | **[04-configuration/CREDENTIALS_CONFIGURED.md](04-configuration/CREDENTIALS_CONFIGURED.md)** | Credentials configuration guide | ### Deployment Paths **Enterprise Deployment (Recommended):** 1. **[02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md](02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md)** - Complete enterprise deployment orchestration 2. **[02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md)** - Network architecture reference 3. **[03-deployment/DEPLOYMENT_READINESS.md](03-deployment/DEPLOYMENT_READINESS.md)** - Pre-deployment validation **Validated Set Deployment:** 1. **[03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md](03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md)** - Validated set deployment procedures 2. **[12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md](12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md)** - Quick reference for validated set 3. **[03-deployment/RUN_DEPLOYMENT.md](03-deployment/RUN_DEPLOYMENT.md)** - Deployment execution guide **Related:** [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md) | [03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md](03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md) --- ## ๐Ÿ—๏ธ Core Architecture & Design ### Network Architecture | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md)** | โญโญโญ | Complete network architecture with 6ร—/28 blocks, VLANs, NAT pools | [04-configuration/ER605_ROUTER_CONFIGURATION.md](04-configuration/ER605_ROUTER_CONFIGURATION.md), [04-configuration/CLOUDFLARE_ZERO_TRUST_GUIDE.md](04-configuration/CLOUDFLARE_ZERO_TRUST_GUIDE.md) | | **[05-network/NETWORK_STATUS.md](05-network/NETWORK_STATUS.md)** | โญโญ | Current network status and configuration | [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md) | ### System Architecture | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md](02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md)** | โญโญโญ | Enterprise-grade deployment orchestration guide | [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md), [07-ccip/CCIP_DEPLOYMENT_SPEC.md](07-ccip/CCIP_DEPLOYMENT_SPEC.md) | | **[02-architecture/VMID_ALLOCATION_FINAL.md](02-architecture/VMID_ALLOCATION_FINAL.md)** | โญโญโญ | Complete VMID allocation registry (11,000 VMIDs) | [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md), [03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md](03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md) | | **[07-ccip/CCIP_DEPLOYMENT_SPEC.md](07-ccip/CCIP_DEPLOYMENT_SPEC.md)** | โญโญโญ | CCIP fleet deployment specification (41-43 nodes) | [02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md](02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md), [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md) | **See also:** [05-network/](05-network/) | [07-ccip/](07-ccip/) --- ## ๐Ÿš€ Deployment & Operations ### Deployment Guides | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md](02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md)** | โญโญโญ | Complete enterprise deployment orchestration | [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md), [03-deployment/DEPLOYMENT_READINESS.md](03-deployment/DEPLOYMENT_READINESS.md) | | **[03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md](03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md)** | โญโญโญ | Validated set deployment procedures | [12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md](12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md), [03-deployment/RUN_DEPLOYMENT.md](03-deployment/RUN_DEPLOYMENT.md) | | **[03-deployment/DEPLOYMENT_READINESS.md](03-deployment/DEPLOYMENT_READINESS.md)** | โญโญ | Pre-deployment validation checklist | [02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md](02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md) | | **[03-deployment/RUN_DEPLOYMENT.md](03-deployment/RUN_DEPLOYMENT.md)** | โญโญ | Deployment execution guide | [03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md](03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md) | | **[03-deployment/REMOTE_DEPLOYMENT.md](03-deployment/REMOTE_DEPLOYMENT.md)** | โญ | Remote deployment procedures | [04-configuration/SSH_SETUP.md](04-configuration/SSH_SETUP.md) | ### Operational Runbooks | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md)** | โญโญโญ | Master runbook index - **All operational procedures** | [09-troubleshooting/TROUBLESHOOTING_FAQ.md](09-troubleshooting/TROUBLESHOOTING_FAQ.md), [06-besu/BESU_ALLOWLIST_RUNBOOK.md](06-besu/BESU_ALLOWLIST_RUNBOOK.md) | | **[03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md](03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md)** | โญโญโญ | Consolidated deployment status | [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md), [02-architecture/VMID_ALLOCATION_FINAL.md](02-architecture/VMID_ALLOCATION_FINAL.md) | **See also:** [09-troubleshooting/](09-troubleshooting/) | [10-best-practices/](10-best-practices/) --- ## โš™๏ธ Configuration & Setup ### Initial Setup | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[04-configuration/MCP_SETUP.md](04-configuration/MCP_SETUP.md)** | โญโญ | MCP Server configuration for Claude Desktop | [01-getting-started/PREREQUISITES.md](01-getting-started/PREREQUISITES.md) | | **[04-configuration/ENV_STANDARDIZATION.md](04-configuration/ENV_STANDARDIZATION.md)** | โญโญ | Environment variable standardization | [04-configuration/SECRETS_KEYS_CONFIGURATION.md](04-configuration/SECRETS_KEYS_CONFIGURATION.md) | | **[04-configuration/CREDENTIALS_CONFIGURED.md](04-configuration/CREDENTIALS_CONFIGURED.md)** | โญ | Credentials configuration guide | [04-configuration/SECRETS_KEYS_CONFIGURATION.md](04-configuration/SECRETS_KEYS_CONFIGURATION.md) | | **[04-configuration/finalize-token.md](04-configuration/finalize-token.md)** | โญ | Token finalization guide | [04-configuration/MCP_SETUP.md](04-configuration/MCP_SETUP.md) | ### Security & Keys | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[04-configuration/SECRETS_KEYS_CONFIGURATION.md](04-configuration/SECRETS_KEYS_CONFIGURATION.md)** | โญโญ | Secrets and keys management | [06-besu/VALIDATOR_KEY_DETAILS.md](06-besu/VALIDATOR_KEY_DETAILS.md), [06-besu/BESU_ALLOWLIST_RUNBOOK.md](06-besu/BESU_ALLOWLIST_RUNBOOK.md) | | **[04-configuration/SSH_SETUP.md](04-configuration/SSH_SETUP.md)** | โญ | SSH key setup and configuration | [03-deployment/REMOTE_DEPLOYMENT.md](03-deployment/REMOTE_DEPLOYMENT.md) | | **[06-besu/VALIDATOR_KEY_DETAILS.md](06-besu/VALIDATOR_KEY_DETAILS.md)** | โญโญ | Validator key details and management | [04-configuration/SECRETS_KEYS_CONFIGURATION.md](04-configuration/SECRETS_KEYS_CONFIGURATION.md) | **See also:** [05-network/](05-network/) | [10-best-practices/](10-best-practices/) --- ## ๐ŸŒ Network Infrastructure ### Router Configuration | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[04-configuration/ER605_ROUTER_CONFIGURATION.md](04-configuration/ER605_ROUTER_CONFIGURATION.md)** | โญโญ | ER605 router configuration guide | [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md) | | **[04-configuration/OMADA_API_SETUP.md](04-configuration/OMADA_API_SETUP.md)** | โญโญ | Omada API integration setup | [ER605_ROUTER_CONFIGURATION.md](04-configuration/ER605_ROUTER_CONFIGURATION.md) | | **[04-configuration/OMADA_HARDWARE_CONFIGURATION_REVIEW.md](04-configuration/OMADA_HARDWARE_CONFIGURATION_REVIEW.md)** | โญโญโญ | Comprehensive Omada hardware and configuration review | [OMADA_API_SETUP.md](04-configuration/OMADA_API_SETUP.md), [ER605_ROUTER_CONFIGURATION.md](04-configuration/ER605_ROUTER_CONFIGURATION.md), [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md) | | **[04-configuration/CLOUDFLARE_ZERO_TRUST_GUIDE.md](04-configuration/CLOUDFLARE_ZERO_TRUST_GUIDE.md)** | โญโญ | Cloudflare Zero Trust integration | [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md), [05-network/CLOUDFLARE_NGINX_INTEGRATION.md](05-network/CLOUDFLARE_NGINX_INTEGRATION.md) | | **[04-configuration/CLOUDFLARE_DNS_TO_CONTAINERS.md](04-configuration/CLOUDFLARE_DNS_TO_CONTAINERS.md)** | โญโญโญ | Mapping Cloudflare DNS to Proxmox LXC containers | [CLOUDFLARE_ZERO_TRUST_GUIDE.md](04-configuration/CLOUDFLARE_ZERO_TRUST_GUIDE.md), [05-network/CLOUDFLARE_NGINX_INTEGRATION.md](05-network/CLOUDFLARE_NGINX_INTEGRATION.md) | | **[04-configuration/CLOUDFLARE_DNS_SPECIFIC_SERVICES.md](04-configuration/CLOUDFLARE_DNS_SPECIFIC_SERVICES.md)** | โญโญโญ | DNS configuration for Mail (100), RPC (2502), and Solace (300X) | [CLOUDFLARE_DNS_TO_CONTAINERS.md](04-configuration/CLOUDFLARE_DNS_TO_CONTAINERS.md) | ### Network Architecture Details | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[05-network/NGINX_ARCHITECTURE_RPC.md](05-network/NGINX_ARCHITECTURE_RPC.md)** | โญ | NGINX RPC architecture | [05-network/RPC_NODE_TYPES_ARCHITECTURE.md](05-network/RPC_NODE_TYPES_ARCHITECTURE.md) | | **[05-network/CLOUDFLARE_NGINX_INTEGRATION.md](05-network/CLOUDFLARE_NGINX_INTEGRATION.md)** | โญ | Cloudflare + NGINX integration | [04-configuration/CLOUDFLARE_ZERO_TRUST_GUIDE.md](04-configuration/CLOUDFLARE_ZERO_TRUST_GUIDE.md) | | **[05-network/RPC_NODE_TYPES_ARCHITECTURE.md](05-network/RPC_NODE_TYPES_ARCHITECTURE.md)** | โญ | RPC node architecture | [05-network/NGINX_ARCHITECTURE_RPC.md](05-network/NGINX_ARCHITECTURE_RPC.md) | **See also:** [02-architecture/](02-architecture/) | [04-configuration/](04-configuration/) --- ## โ›“๏ธ Besu & Blockchain Operations ### Besu Configuration | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[06-besu/BESU_ALLOWLIST_RUNBOOK.md](06-besu/BESU_ALLOWLIST_RUNBOOK.md)** | โญโญ | Besu allowlist generation and management | [06-besu/BESU_ALLOWLIST_QUICK_START.md](06-besu/BESU_ALLOWLIST_QUICK_START.md), [06-besu/BESU_NODES_FILE_REFERENCE.md](06-besu/BESU_NODES_FILE_REFERENCE.md) | | **[06-besu/BESU_ALLOWLIST_QUICK_START.md](06-besu/BESU_ALLOWLIST_QUICK_START.md)** | โญโญ | Quick start for allowlist issues | [06-besu/BESU_ALLOWLIST_RUNBOOK.md](06-besu/BESU_ALLOWLIST_RUNBOOK.md), [09-troubleshooting/TROUBLESHOOTING_FAQ.md](09-troubleshooting/TROUBLESHOOTING_FAQ.md) | | **[06-besu/BESU_NODES_FILE_REFERENCE.md](06-besu/BESU_NODES_FILE_REFERENCE.md)** | โญโญ | Besu nodes file reference | [06-besu/BESU_ALLOWLIST_RUNBOOK.md](06-besu/BESU_ALLOWLIST_RUNBOOK.md) | ### Besu References | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[06-besu/BESU_OFFICIAL_REFERENCE.md](06-besu/BESU_OFFICIAL_REFERENCE.md)** | โญ | Official Besu references | [06-besu/BESU_OFFICIAL_UPDATES.md](06-besu/BESU_OFFICIAL_UPDATES.md) | | **[06-besu/BESU_OFFICIAL_UPDATES.md](06-besu/BESU_OFFICIAL_UPDATES.md)** | โญ | Official Besu updates | [06-besu/BESU_OFFICIAL_REFERENCE.md](06-besu/BESU_OFFICIAL_REFERENCE.md) | | **[06-besu/QUORUM_GENESIS_TOOL_REVIEW.md](06-besu/QUORUM_GENESIS_TOOL_REVIEW.md)** | โญ | Genesis tool review | [06-besu/VALIDATOR_KEY_DETAILS.md](06-besu/VALIDATOR_KEY_DETAILS.md) | | **[06-besu/COMPREHENSIVE_CONSISTENCY_REVIEW.md](06-besu/COMPREHENSIVE_CONSISTENCY_REVIEW.md)** | โญ | Comprehensive consistency review | [09-troubleshooting/QBFT_TROUBLESHOOTING.md](09-troubleshooting/QBFT_TROUBLESHOOTING.md) | **See also:** [09-troubleshooting/](09-troubleshooting/) | [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md) --- ## ๐Ÿ”— CCIP & Chainlink ### CCIP Deployment | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[07-ccip/CCIP_DEPLOYMENT_SPEC.md](07-ccip/CCIP_DEPLOYMENT_SPEC.md)** | โญโญโญ | CCIP fleet deployment specification (41-43 nodes) | [02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md](02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md), [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md) | ### RPC Configuration | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[05-network/RPC_TEMPLATE_TYPES.md](05-network/RPC_TEMPLATE_TYPES.md)** | โญ | RPC template types | [05-network/RPC_NODE_TYPES_ARCHITECTURE.md](05-network/RPC_NODE_TYPES_ARCHITECTURE.md) | **See also:** [02-architecture/](02-architecture/) | [05-network/](05-network/) --- ## ๐Ÿ“Š Monitoring & Observability ### Monitoring Setup | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[08-monitoring/MONITORING_SUMMARY.md](08-monitoring/MONITORING_SUMMARY.md)** | โญโญ | Monitoring setup and configuration | [08-monitoring/BLOCK_PRODUCTION_MONITORING.md](08-monitoring/BLOCK_PRODUCTION_MONITORING.md) | | **[08-monitoring/BLOCK_PRODUCTION_MONITORING.md](08-monitoring/BLOCK_PRODUCTION_MONITORING.md)** | โญโญ | Block production monitoring | [08-monitoring/MONITORING_SUMMARY.md](08-monitoring/MONITORING_SUMMARY.md), [09-troubleshooting/QBFT_TROUBLESHOOTING.md](09-troubleshooting/QBFT_TROUBLESHOOTING.md) | **See also:** [09-troubleshooting/](09-troubleshooting/) | [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md) --- ## ๐Ÿ”ง Troubleshooting ### Troubleshooting Guides | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[09-troubleshooting/TROUBLESHOOTING_FAQ.md](09-troubleshooting/TROUBLESHOOTING_FAQ.md)** | โญโญโญ | Common issues and solutions - **Start here for problems** | [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md), [09-troubleshooting/QBFT_TROUBLESHOOTING.md](09-troubleshooting/QBFT_TROUBLESHOOTING.md) | | **[09-troubleshooting/QBFT_TROUBLESHOOTING.md](09-troubleshooting/QBFT_TROUBLESHOOTING.md)** | โญโญ | QBFT consensus troubleshooting | [09-troubleshooting/TROUBLESHOOTING_FAQ.md](09-troubleshooting/TROUBLESHOOTING_FAQ.md), [08-monitoring/BLOCK_PRODUCTION_MONITORING.md](08-monitoring/BLOCK_PRODUCTION_MONITORING.md) | | **[06-besu/BESU_ALLOWLIST_QUICK_START.md](06-besu/BESU_ALLOWLIST_QUICK_START.md)** | โญโญ | Quick start for allowlist issues | [06-besu/BESU_ALLOWLIST_RUNBOOK.md](06-besu/BESU_ALLOWLIST_RUNBOOK.md), [09-troubleshooting/TROUBLESHOOTING_FAQ.md](09-troubleshooting/TROUBLESHOOTING_FAQ.md) | **See also:** [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md) | [10-best-practices/](10-best-practices/) --- ## โœ… Best Practices & Recommendations ### Recommendations | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md](10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md)** | โญโญโญ | Comprehensive recommendations (100+ items) | [10-best-practices/IMPLEMENTATION_CHECKLIST.md](10-best-practices/IMPLEMENTATION_CHECKLIST.md), [10-best-practices/BEST_PRACTICES_SUMMARY.md](10-best-practices/BEST_PRACTICES_SUMMARY.md) | | **[10-best-practices/IMPLEMENTATION_CHECKLIST.md](10-best-practices/IMPLEMENTATION_CHECKLIST.md)** | โญโญ | Implementation checklist - **Track progress here** | [10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md](10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md) | | **[10-best-practices/BEST_PRACTICES_SUMMARY.md](10-best-practices/BEST_PRACTICES_SUMMARY.md)** | โญโญ | Best practices summary | [10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md](10-best-practices/RECOMMENDATIONS_AND_SUGGESTIONS.md) | | **[10-best-practices/QUICK_WINS.md](10-best-practices/QUICK_WINS.md)** | โญ | Quick wins implementation guide | [10-best-practices/IMPLEMENTATION_CHECKLIST.md](10-best-practices/IMPLEMENTATION_CHECKLIST.md) | **See also:** [04-configuration/](04-configuration/) | [09-troubleshooting/](09-troubleshooting/) --- ## ๐Ÿ“š Technical References ### Reference Documents | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[11-references/TOKEN_LIST_AUTHORING_GUIDE.md](11-references/TOKEN_LIST_AUTHORING_GUIDE.md)** | โญโญโญ | Token list authoring and management guide | [token-lists/README.md](../../token-lists/README.md), [11-references/CHAIN138_TOKEN_ADDRESSES.md](11-references/CHAIN138_TOKEN_ADDRESSES.md) | | **[11-references/CHAIN138_TOKEN_ADDRESSES.md](11-references/CHAIN138_TOKEN_ADDRESSES.md)** | โญโญ | ChainID 138 token contract addresses reference | [11-references/TOKEN_LIST_AUTHORING_GUIDE.md](11-references/TOKEN_LIST_AUTHORING_GUIDE.md) | | **[11-references/APT_PACKAGES_CHECKLIST.md](11-references/APT_PACKAGES_CHECKLIST.md)** | โญ | APT packages checklist | [01-getting-started/PREREQUISITES.md](01-getting-started/PREREQUISITES.md) | | **[11-references/PATHS_REFERENCE.md](11-references/PATHS_REFERENCE.md)** | โญ | Paths reference guide | [12-quick-reference/QUICK_REFERENCE.md](12-quick-reference/QUICK_REFERENCE.md) | | **[11-references/SCRIPT_REVIEW.md](11-references/SCRIPT_REVIEW.md)** | โญ | Script review documentation | [11-references/TEMPLATE_BASE_WORKFLOW.md](11-references/TEMPLATE_BASE_WORKFLOW.md) | | **[11-references/TEMPLATE_BASE_WORKFLOW.md](11-references/TEMPLATE_BASE_WORKFLOW.md)** | โญ | Template base workflow guide | [11-references/SCRIPT_REVIEW.md](11-references/SCRIPT_REVIEW.md) | ### Token Lists | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[token-lists/README.md](../../token-lists/README.md)** | โญโญโญ | Token lists project documentation | [11-references/TOKEN_LIST_AUTHORING_GUIDE.md](11-references/TOKEN_LIST_AUTHORING_GUIDE.md) | | **[token-lists/lists/dbis-138.tokenlist.json](../../token-lists/lists/dbis-138.tokenlist.json)** | โญโญโญ | ChainID 138 token list (6 tokens) | [11-references/CHAIN138_TOKEN_ADDRESSES.md](11-references/CHAIN138_TOKEN_ADDRESSES.md) | | **[token-lists/lists/ethereum-mainnet.tokenlist.json](../../token-lists/lists/ethereum-mainnet.tokenlist.json)** | โญโญ | Ethereum Mainnet token list (1 token: USDT) | - | | **[token-lists/lists/all-mainnet.tokenlist.json](../../token-lists/lists/all-mainnet.tokenlist.json)** | โญโญ | ALL Mainnet token list (9 tokens including AUSDT) | - | --- ## ๐Ÿ“‹ Quick References ### Quick Reference Guides | Document | Priority | Description | Related Documents | |----------|----------|-------------|-------------------| | **[12-quick-reference/QUICK_REFERENCE.md](12-quick-reference/QUICK_REFERENCE.md)** | โญโญ | Quick reference for ProxmoxVE scripts | [12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md](12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md) | | **[12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md](12-quick-reference/VALIDATED_SET_QUICK_REFERENCE.md)** | โญโญ | Quick reference for validated set | [03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md](03-deployment/VALIDATED_SET_DEPLOYMENT_GUIDE.md) | | **[12-quick-reference/QUICK_START_TEMPLATE.md](12-quick-reference/QUICK_START_TEMPLATE.md)** | โญ | Quick start template guide | [01-getting-started/README_START_HERE.md](01-getting-started/README_START_HERE.md) | --- ## ๐Ÿ“ˆ Documentation Status ### Recent Updates - โœ… **2025-01-20**: Documentation quality fixes complete (duplicates eliminated, formats standardized) - โœ… **2025-01-20**: Cloudflare routing consolidated into master reference document - โœ… **2025-01-20**: Network architecture duplication resolved - โœ… **2025-01-20**: All cross-references added and standardized - โœ… **2025-01-20**: Complete documentation reorganization (340 files organized) - โœ… **2025-01-20**: Created missing documentation (disaster recovery, backup/restore, security, change management, performance) - โœ… **2025-01-20**: Organized Cloudflare documentation into subdirectory - โœ… **2025-01-20**: Standardized file naming convention - โœ… **2025-01-20**: Created documentation style guide - โœ… **2025-01-20**: Network architecture upgraded to v2.0 - โœ… **2025-01-20**: Orchestration deployment guide created - โœ… **2025-01-20**: 75+ documents archived, organized structure ### Document Statistics - **Total Active Documents:** 48 (organized in 12 directories) - **Archived Documents:** 75+ - **Core Architecture Documents:** 3 - **Deployment Guides:** 6 - **Troubleshooting Guides:** 2 - **Best Practices:** 4 ### Maintenance - **Update Frequency:** Critical documents updated weekly, others monthly - **Review Cycle:** Quarterly for architecture, monthly for operations - **Archive Policy:** Historical documents moved to `archive/` --- ## ๐Ÿ”— Cross-Reference Map ### By Workflow **Deployment Workflow:** 1. [01-getting-started/PREREQUISITES.md](01-getting-started/PREREQUISITES.md) โ†’ 2. [03-deployment/DEPLOYMENT_READINESS.md](03-deployment/DEPLOYMENT_READINESS.md) โ†’ 3. [02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md](02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md) โ†’ 4. [03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md](03-deployment/DEPLOYMENT_STATUS_CONSOLIDATED.md) **Network Setup Workflow:** 1. [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md) โ†’ 2. [04-configuration/ER605_ROUTER_CONFIGURATION.md](04-configuration/ER605_ROUTER_CONFIGURATION.md) โ†’ 3. [04-configuration/CLOUDFLARE_ZERO_TRUST_GUIDE.md](04-configuration/CLOUDFLARE_ZERO_TRUST_GUIDE.md) **Troubleshooting Workflow:** 1. [09-troubleshooting/TROUBLESHOOTING_FAQ.md](09-troubleshooting/TROUBLESHOOTING_FAQ.md) โ†’ 2. [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md) โ†’ 3. [09-troubleshooting/QBFT_TROUBLESHOOTING.md](09-troubleshooting/QBFT_TROUBLESHOOTING.md) (if consensus issues) --- ## ๐Ÿ“ž Support & Help ### Getting Help 1. **Common Issues:** Check [09-troubleshooting/TROUBLESHOOTING_FAQ.md](09-troubleshooting/TROUBLESHOOTING_FAQ.md) 2. **Operational Procedures:** See [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md) 3. **Architecture Questions:** Review [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md) 4. **Deployment Questions:** See [02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md](02-architecture/ORCHESTRATION_DEPLOYMENT_GUIDE.md) ### Related Documentation - **[DOCUMENTATION_STYLE_GUIDE.md](DOCUMENTATION_STYLE_GUIDE.md)** โญโญโญ - Documentation standards - **[DOCUMENTATION_QUALITY_REVIEW.md](DOCUMENTATION_QUALITY_REVIEW.md)** โญโญ - Quality review findings - **[DOCUMENTATION_FIXES_COMPLETE.md](DOCUMENTATION_FIXES_COMPLETE.md)** โญโญ - Completed fixes - **[DOCUMENTATION_ENHANCEMENTS_RECOMMENDATIONS.md](DOCUMENTATION_ENHANCEMENTS_RECOMMENDATIONS.md)** โญโญโญ - Enhancement recommendations and visual elements - **[CLEANUP_SUMMARY.md](CLEANUP_SUMMARY.md)** - Documentation cleanup summary - **[DOCUMENTATION_UPGRADE_SUMMARY.md](DOCUMENTATION_UPGRADE_SUMMARY.md)** - Documentation upgrade summary - **[archive/README.md](01-getting-started/README.md)** - Archived documentation index --- **Last Updated:** 2025-01-20 **Maintained By:** Infrastructure Team **Review Cycle:** Monthly **Version:** 5.1