e254f81a83
Some checks failed
CI/CD Pipeline / Solidity Contracts (push) Failing after 1m4s
CI/CD Pipeline / Security Scanning (push) Successful in 2m13s
CI/CD Pipeline / Lint and Format (push) Failing after 34s
CI/CD Pipeline / Terraform Validation (push) Failing after 21s
CI/CD Pipeline / Kubernetes Validation (push) Successful in 22s
Validation / validate-genesis (push) Successful in 26s
Validation / validate-terraform (push) Failing after 24s
Validation / validate-kubernetes (push) Failing after 8s
Validation / validate-smart-contracts (push) Failing after 8s
Validation / validate-security (push) Failing after 1m10s
Validation / validate-documentation (push) Failing after 15s
Apply clean archive patches (WETH CREATE2 doc, DeployKeeper script), restore emoney unit tests from .bak, add keeper npm scripts without replacing the Hardhat package.json, untrack relay lane secret env files, and document superseded patch hunks in SIBLING_WIP_IMPORT.md.
Documentation Index
Last Updated: 2026-04-12
Status: Active
This is the entry point for all project documentation. For the complete documentation index, see MASTER_DOCUMENTATION_INDEX.md.
Quick Navigation
- Master Documentation Index - Complete index of all documentation
- Documentation Review & Recommendations - Comprehensive documentation review
- Quick Fixes Guide - Critical fixes checklist
📁 Directory Structure
🏗️ architecture/
Architecture and design documentation:
- Network architecture
- Enterprise architecture blueprints
- System design diagrams
- Directory structure
🚀 deployment/
Deployment guides and procedures:
- Mainnet deployment
- ChainID 138 deployment
- VM deployment
- Validator node deployment
- Phase-based deployment guides
- Quick start deployment
⚙️ operations/
Operational documentation organized into subdirectories:
operations/integrations/
Integration guides:
- CCIP (Cross-Chain Interoperability Protocol)
- MetaMask integration
- Firefly integration
- Cacti integration
- Bridge configuration
- WETH deployment
operations/status-reports/
Status-report navigation:
- Active-vs-archive index
- Pointers to current deployment and routing status docs
- Links into archived historical report collections
operations/tasks/
Task management and next steps:
- TODO lists
- Next steps documentation
- Action items
- Master task lists
- Remaining tasks
☁️ azure/
Azure-specific documentation:
- Azure Well-Architected Framework
- Azure region setup
- Quota management
- Multi-region deployment
- Kubernetes configuration
- VM size restrictions
🔒 security/
Security documentation:
- Security scanning guides
- Security audit checklists
- Security compliance
- Security scores
- SolidityScan setup
⚙️ configuration/
Configuration and setup guides:
- Environment setup
- Configuration guides
- Naming conventions
- Terraform backend setup
- Terraform status
📡 api/
API documentation:
- API reference
- Blockscout API
- Tatum SDK
📖 guides/
General guides and how-tos:
- Troubleshooting
- Migration guides
- Quick start guides
- Validation guides
- Integration guides
- Asset guides
- Gas calculations
🏛️ governance/
Governance and contribution:
- Governance framework
- Contributing guidelines
- Changelog
🔗 ccip-integration/
CCIP integration specific documentation:
- CCIP deployment guide
- CCIP quick start
- CCIP README
📊 quota-reports/
Azure quota validation reports and analysis:
- Quota usage reports
- Quota validation CSVs
- Region quota analysis
📝 project-reviews/
Project review documentation:
- Migration progress
- Project reviews
- Review summaries
- Completion reports
📜 scripts/
Script documentation (auto-generated):
- Deployment scripts
- Automation scripts
- Azure scripts
- Security scripts
- Validation scripts
- VM deployment scripts
🏷️ tags/
Documentation tags and metadata
🔍 Quick Reference
Getting Started
Key Integrations
Operations
Azure Resources
📚 Documentation Standards
- All documentation is in Markdown format
- Use clear, descriptive filenames
- Include table of contents for long documents
- Keep documentation up to date with code changes
🔄 Maintenance
This documentation structure is maintained as part of the project cleanup process. For questions or suggestions about documentation organization, please refer to the Contributing Guidelines.