d-bis/proxmox
4
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
cc8dcaf3569561c39306964b3ed5064d92748133
proxmox/docs/MASTER_INDEX.md

468 lines
30 KiB
Markdown
Raw Normal View History

Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
# Master Documentation Index
**Last Updated:** 2025-01-20
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
**Document Version:** 5.0
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
**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
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
├── 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
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
│
├── 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
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
│ ├── PHYSICAL_HARDWARE_INVENTORY.md
│ ├── VMID_ALLOCATION_FINAL.md
│ ├── DOMAIN_STRUCTURE.md
│ └── HOSTNAME_MIGRATION_GUIDE.md
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
│
├── 03-deployment/ # Deployment & operations
│ ├── README.md
│ ├── OPERATIONAL_RUNBOOKS.md
│ ├── VALIDATED_SET_DEPLOYMENT_GUIDE.md
│ ├── DEPLOYMENT_STATUS_CONSOLIDATED.md
│ ├── DEPLOYMENT_READINESS.md
│ ├── RUN_DEPLOYMENT.md
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
│ ├── REMOTE_DEPLOYMENT.md
│ ├── DISASTER_RECOVERY.md
│ ├── BACKUP_AND_RESTORE.md
│ └── CHANGE_MANAGEMENT.md
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
│
├── 04-configuration/ # Configuration & setup
│ ├── README.md
│ ├── MCP_SETUP.md
│ ├── ER605_ROUTER_CONFIGURATION.md
│ ├── OMADA_API_SETUP.md
│ ├── OMADA_HARDWARE_CONFIGURATION_REVIEW.md
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
│ ├── 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
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
│ ├── SECRETS_KEYS_CONFIGURATION.md
│ ├── ENV_STANDARDIZATION.md
│ ├── CREDENTIALS_CONFIGURED.md
│ ├── SSH_SETUP.md
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
│ └── FINALIZE_TOKEN.md
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
│
├── 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
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
│ ├── QBFT_TROUBLESHOOTING.md
│ └── SECURITY_INCIDENT_RESPONSE.md
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
│
├── 10-best-practices/ # Best practices
│ ├── README.md
│ ├── RECOMMENDATIONS_AND_SUGGESTIONS.md
│ ├── IMPLEMENTATION_CHECKLIST.md
│ ├── BEST_PRACTICES_SUMMARY.md
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
│ ├── QUICK_WINS.md
│ └── PERFORMANCE_TUNING.md
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
│
├── 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 |
|----------|----------|-------------|-------------------|
Add complete token lists for Ethereum Mainnet, ChainID 138, and ALL Mainnet - Added Ethereum Mainnet token list (1 token: USDT) - Updated ChainID 138 token list (6 tokens: added cUSDT and cUSDC) - Added ALL Mainnet token list (9 tokens including AUSDT) - Discovered ALL Mainnet tokens via Transfer event scanning - Updated validation scripts for multi-chain support - Created comprehensive documentation and guides - Updated master documentation indexes - All token lists validated and ready for submission
2026-01-26 13:52:05 -08:00
| **[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) |
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
| **[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) |
Add complete token lists for Ethereum Mainnet, ChainID 138, and ALL Mainnet - Added Ethereum Mainnet token list (1 token: USDT) - Updated ChainID 138 token list (6 tokens: added cUSDT and cUSDC) - Added ALL Mainnet token list (9 tokens including AUSDT) - Discovered ALL Mainnet tokens via Transfer event scanning - Updated validation scripts for multi-chain support - Created comprehensive documentation and guides - Updated master documentation indexes - All token lists validated and ready for submission
2026-01-26 13:52:05 -08:00
### 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) | - |
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
---
## 📋 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
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
- ✅ **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
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
- ✅ **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
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
- **[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
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
- **[CLEANUP_SUMMARY.md](CLEANUP_SUMMARY.md)** - Documentation cleanup summary
- **[DOCUMENTATION_UPGRADE_SUMMARY.md](DOCUMENTATION_UPGRADE_SUMMARY.md)** - Documentation upgrade summary
Complete optional next steps: fix references and consolidate duplicates - Fixed 104 broken references in 59 files - Consolidated 40+ duplicate status files - Archived duplicates to reports/archive/duplicates/ - Created scripts for reference fixing and consolidation - Updated content inconsistency reports All optional cleanup tasks complete.
2026-01-06 02:25:38 -08:00
- **[archive/README.md](01-getting-started/README.md)** - Archived documentation index
Refactor code for improved readability and performance
2025-12-21 22:32:09 -08:00
---
**Last Updated:** 2025-01-20
**Maintained By:** Infrastructure Team
**Review Cycle:** Monthly
Complete markdown files cleanup and organization - Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
2026-01-06 01:46:25 -08:00
**Version:** 5.1
Reference in New Issue Copy Permalink