docs/README.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](MASTER_DOCUMENTATION_INDEX.md).

## Quick Navigation

- **[Master Documentation Index](MASTER_DOCUMENTATION_INDEX.md)** - Complete index of all documentation
- **[Documentation Review & Recommendations](DOCUMENTATION_REVIEW_AND_RECOMMENDATIONS.md)** - Comprehensive documentation review
- **[Quick Fixes Guide](DOCUMENTATION_QUICK_FIXES.md)** - Critical fixes checklist

## 📁 Directory Structure

### 🏗️ [architecture/](architecture/)
Architecture and design documentation:
- Network architecture
- Enterprise architecture blueprints
- System design diagrams
- Directory structure

### 🚀 [deployment/](deployment/)
Deployment guides and procedures:
- Mainnet deployment
- ChainID 138 deployment
- VM deployment
- Validator node deployment
- Phase-based deployment guides
- Quick start deployment

### ⚙️ [operations/](operations/)
Operational documentation organized into subdirectories:

#### [operations/integrations/](operations/integrations/)
Integration guides:
- CCIP (Cross-Chain Interoperability Protocol)
- MetaMask integration
- Firefly integration
- Cacti integration
- Bridge configuration
- WETH deployment

#### [operations/status-reports/](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/](operations/tasks/)
Task management and next steps:
- TODO lists
- Next steps documentation
- Action items
- Master task lists
- Remaining tasks

### ☁️ [azure/](azure/)
Azure-specific documentation:
- Azure Well-Architected Framework
- Azure region setup
- Quota management
- Multi-region deployment
- Kubernetes configuration
- VM size restrictions

### 🔒 [security/](security/)
Security documentation:
- Security scanning guides
- Security audit checklists
- Security compliance
- Security scores
- SolidityScan setup

### ⚙️ [configuration/](configuration/)
Configuration and setup guides:
- Environment setup
- Configuration guides
- Naming conventions
- Terraform backend setup
- Terraform status

### 📡 [api/](api/)
API documentation:
- API reference
- Blockscout API
- Tatum SDK

### 📖 [guides/](guides/)
General guides and how-tos:
- Troubleshooting
- Migration guides
- Quick start guides
- Validation guides
- Integration guides
- Asset guides
- Gas calculations

### 🏛️ [governance/](governance/)
Governance and contribution:
- Governance framework
- Contributing guidelines
- Changelog

### 🔗 [ccip-integration/](ccip-integration/)
CCIP integration specific documentation:
- CCIP deployment guide
- CCIP quick start
- CCIP README

### 📊 [quota-reports/](quota-reports/)
Azure quota validation reports and analysis:
- Quota usage reports
- Quota validation CSVs
- Region quota analysis

### 📝 [project-reviews/](project-reviews/)
Project review documentation:
- Migration progress
- Project reviews
- Review summaries
- Completion reports

### 📜 [scripts/](scripts/)
Script documentation (auto-generated):
- Deployment scripts
- Automation scripts
- Azure scripts
- Security scripts
- Validation scripts
- VM deployment scripts

### 🏷️ [tags/](tags/)
Documentation tags and metadata

## 🔍 Quick Reference

### Getting Started
- [Quick Start Guide](guides/QUICKSTART.md)
- [Deployment Guide](deployment/DEPLOYMENT.md)
- [Architecture Overview](architecture/ARCHITECTURE.md)

### Key Integrations
- [CCIP Integration](operations/integrations/CCIP_INTEGRATION.md)
- [MetaMask Integration](operations/integrations/METAMASK_INTEGRATION.md)
- [Firefly Integration](operations/integrations/FIREFLY_INTEGRATION.md)

### Operations
- [Troubleshooting](guides/TROUBLESHOOTING.md)
- [Next Steps](operations/tasks/NEXT_STEPS.md)
- [Task List](operations/tasks/TODO.md)
- [Status Reports Index](operations/status-reports/STATUS_REPORTS_INDEX.md)

### Azure Resources
- [Azure Setup](azure/AZURE_REGION_SETUP.md)
- [Quota Management](azure/QUOTA_REQUIREMENTS.md)
- [Well-Architected Framework](azure/AZURE_WELL_ARCHITECTED_IMPLEMENTATION.md)

## 📚 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](governance/CONTRIBUTING.md).
Add Oracle Aggregator and CCIP Integration - Introduced Aggregator.sol for Chainlink-compatible oracle functionality, including round-based updates and access control. - Added OracleWithCCIP.sol to extend Aggregator with CCIP cross-chain messaging capabilities. - Created .gitmodules to include OpenZeppelin contracts as a submodule. - Developed a comprehensive deployment guide in NEXT_STEPS_COMPLETE_GUIDE.md for Phase 2 and smart contract deployment. - Implemented Vite configuration for the orchestration portal, supporting both Vue and React frameworks. - Added server-side logic for the Multi-Cloud Orchestration Portal, including API endpoints for environment management and monitoring. - Created scripts for resource import and usage validation across non-US regions. - Added tests for CCIP error handling and integration to ensure robust functionality. - Included various new files and directories for the orchestration portal and deployment scripts. 2025-12-12 14:57:48 -08:00			`# Documentation Index`

Archive legacy status docs and canonicalize genesis entrypoints 2026-04-13 21:45:16 -07:00			`Last Updated: 2026-04-12`
Add Oracle Aggregator and CCIP Integration - Introduced Aggregator.sol for Chainlink-compatible oracle functionality, including round-based updates and access control. - Added OracleWithCCIP.sol to extend Aggregator with CCIP cross-chain messaging capabilities. - Created .gitmodules to include OpenZeppelin contracts as a submodule. - Developed a comprehensive deployment guide in NEXT_STEPS_COMPLETE_GUIDE.md for Phase 2 and smart contract deployment. - Implemented Vite configuration for the orchestration portal, supporting both Vue and React frameworks. - Added server-side logic for the Multi-Cloud Orchestration Portal, including API endpoints for environment management and monitoring. - Created scripts for resource import and usage validation across non-US regions. - Added tests for CCIP error handling and integration to ensure robust functionality. - Included various new files and directories for the orchestration portal and deployment scripts. 2025-12-12 14:57:48 -08:00			`Status: Active`

			`This is the entry point for all project documentation. For the complete documentation index, see [MASTER_DOCUMENTATION_INDEX.md](MASTER_DOCUMENTATION_INDEX.md).`

			`## Quick Navigation`

			`- [Master Documentation Index](MASTER_DOCUMENTATION_INDEX.md) - Complete index of all documentation`
			`- [Documentation Review & Recommendations](DOCUMENTATION_REVIEW_AND_RECOMMENDATIONS.md) - Comprehensive documentation review`
			`- [Quick Fixes Guide](DOCUMENTATION_QUICK_FIXES.md) - Critical fixes checklist`

			`## 📁 Directory Structure`

			`### 🏗️ [architecture/](architecture/)`
			`Architecture and design documentation:`
			`- Network architecture`
			`- Enterprise architecture blueprints`
			`- System design diagrams`
			`- Directory structure`

			`### 🚀 [deployment/](deployment/)`
			`Deployment guides and procedures:`
			`- Mainnet deployment`
			`- ChainID 138 deployment`
			`- VM deployment`
			`- Validator node deployment`
			`- Phase-based deployment guides`
			`- Quick start deployment`

			`### ⚙️ [operations/](operations/)`
			`Operational documentation organized into subdirectories:`

			`#### [operations/integrations/](operations/integrations/)`
			`Integration guides:`
			`- CCIP (Cross-Chain Interoperability Protocol)`
			`- MetaMask integration`
			`- Firefly integration`
			`- Cacti integration`
			`- Bridge configuration`
			`- WETH deployment`

			`#### [operations/status-reports/](operations/status-reports/)`
Archive legacy status docs and canonicalize genesis entrypoints 2026-04-13 21:45:16 -07:00			`Status-report navigation:`
			`- Active-vs-archive index`
			`- Pointers to current deployment and routing status docs`
			`- Links into archived historical report collections`
Add Oracle Aggregator and CCIP Integration - Introduced Aggregator.sol for Chainlink-compatible oracle functionality, including round-based updates and access control. - Added OracleWithCCIP.sol to extend Aggregator with CCIP cross-chain messaging capabilities. - Created .gitmodules to include OpenZeppelin contracts as a submodule. - Developed a comprehensive deployment guide in NEXT_STEPS_COMPLETE_GUIDE.md for Phase 2 and smart contract deployment. - Implemented Vite configuration for the orchestration portal, supporting both Vue and React frameworks. - Added server-side logic for the Multi-Cloud Orchestration Portal, including API endpoints for environment management and monitoring. - Created scripts for resource import and usage validation across non-US regions. - Added tests for CCIP error handling and integration to ensure robust functionality. - Included various new files and directories for the orchestration portal and deployment scripts. 2025-12-12 14:57:48 -08:00
			`#### [operations/tasks/](operations/tasks/)`
			`Task management and next steps:`
			`- TODO lists`
			`- Next steps documentation`
			`- Action items`
			`- Master task lists`
			`- Remaining tasks`

			`### ☁️ [azure/](azure/)`
			`Azure-specific documentation:`
			`- Azure Well-Architected Framework`
			`- Azure region setup`
			`- Quota management`
			`- Multi-region deployment`
			`- Kubernetes configuration`
			`- VM size restrictions`

			`### 🔒 [security/](security/)`
			`Security documentation:`
			`- Security scanning guides`
			`- Security audit checklists`
			`- Security compliance`
			`- Security scores`
			`- SolidityScan setup`

			`### ⚙️ [configuration/](configuration/)`
			`Configuration and setup guides:`
			`- Environment setup`
			`- Configuration guides`
			`- Naming conventions`
			`- Terraform backend setup`
			`- Terraform status`

			`### 📡 [api/](api/)`
			`API documentation:`
			`- API reference`
			`- Blockscout API`
			`- Tatum SDK`

			`### 📖 [guides/](guides/)`
			`General guides and how-tos:`
			`- Troubleshooting`
			`- Migration guides`
			`- Quick start guides`
			`- Validation guides`
			`- Integration guides`
			`- Asset guides`
			`- Gas calculations`

			`### 🏛️ [governance/](governance/)`
			`Governance and contribution:`
			`- Governance framework`
			`- Contributing guidelines`
			`- Changelog`

			`### 🔗 [ccip-integration/](ccip-integration/)`
			`CCIP integration specific documentation:`
			`- CCIP deployment guide`
			`- CCIP quick start`
			`- CCIP README`

			`### 📊 [quota-reports/](quota-reports/)`
			`Azure quota validation reports and analysis:`
			`- Quota usage reports`
			`- Quota validation CSVs`
			`- Region quota analysis`

			`### 📝 [project-reviews/](project-reviews/)`
			`Project review documentation:`
			`- Migration progress`
			`- Project reviews`
			`- Review summaries`
			`- Completion reports`

			`### 📜 [scripts/](scripts/)`
			`Script documentation (auto-generated):`
			`- Deployment scripts`
			`- Automation scripts`
			`- Azure scripts`
			`- Security scripts`
			`- Validation scripts`
			`- VM deployment scripts`

			`### 🏷️ [tags/](tags/)`
			`Documentation tags and metadata`

			`## 🔍 Quick Reference`

			`### Getting Started`
			`- [Quick Start Guide](guides/QUICKSTART.md)`
			`- [Deployment Guide](deployment/DEPLOYMENT.md)`
			`- [Architecture Overview](architecture/ARCHITECTURE.md)`

			`### Key Integrations`
			`- [CCIP Integration](operations/integrations/CCIP_INTEGRATION.md)`
			`- [MetaMask Integration](operations/integrations/METAMASK_INTEGRATION.md)`
			`- [Firefly Integration](operations/integrations/FIREFLY_INTEGRATION.md)`

			`### Operations`
			`- [Troubleshooting](guides/TROUBLESHOOTING.md)`
			`- [Next Steps](operations/tasks/NEXT_STEPS.md)`
			`- [Task List](operations/tasks/TODO.md)`
Archive legacy status docs and canonicalize genesis entrypoints 2026-04-13 21:45:16 -07:00			`- [Status Reports Index](operations/status-reports/STATUS_REPORTS_INDEX.md)`
Add Oracle Aggregator and CCIP Integration - Introduced Aggregator.sol for Chainlink-compatible oracle functionality, including round-based updates and access control. - Added OracleWithCCIP.sol to extend Aggregator with CCIP cross-chain messaging capabilities. - Created .gitmodules to include OpenZeppelin contracts as a submodule. - Developed a comprehensive deployment guide in NEXT_STEPS_COMPLETE_GUIDE.md for Phase 2 and smart contract deployment. - Implemented Vite configuration for the orchestration portal, supporting both Vue and React frameworks. - Added server-side logic for the Multi-Cloud Orchestration Portal, including API endpoints for environment management and monitoring. - Created scripts for resource import and usage validation across non-US regions. - Added tests for CCIP error handling and integration to ensure robust functionality. - Included various new files and directories for the orchestration portal and deployment scripts. 2025-12-12 14:57:48 -08:00
			`### Azure Resources`
			`- [Azure Setup](azure/AZURE_REGION_SETUP.md)`
			`- [Quota Management](azure/QUOTA_REQUIREMENTS.md)`
			`- [Well-Architected Framework](azure/AZURE_WELL_ARCHITECTED_IMPLEMENTATION.md)`

			`## 📚 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](governance/CONTRIBUTING.md).`