d-bis/smom-dbis-138
4
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity
Files
main
smom-dbis-138/docs/MASTER_DOCUMENTATION_INDEX.md
defiQUG 5efe36b1e0 chore: sync submodule state (parent ref update) 
Made-with: Cursor
2026-03-02 12:14:09 -08:00

293 lines
13 KiB
Markdown
Raw Permalink Blame History

# Master Documentation Index
**Last Updated**: 2026-01-31
**Project**: DeFi Oracle Meta Mainnet (ChainID 138)
**Status**: Active - Primary Documentation Index
This is the **master index** of all project documentation. Use this as your starting point to find any documentation in the project.
> **Note**: This is the primary documentation index. For a simple entry point, see [README.md](README.md).
---
## 🚀 Quick Start
- **[README.md](../README.md)** - Project overview, features, and quick start guide
- **[Getting Started](guides/GETTING_STARTED.md)** - Getting started guide for different user types
- **[DEPLOYMENT_QUICK_START.md](DEPLOYMENT_QUICK_START.md)** - Fast deployment guide
- **[PARALLEL_COMPLETION_TASK_LIST.md](PARALLEL_COMPLETION_TASK_LIST.md)** - Complete task list for deployment
- **[Documentation Review](DOCUMENTATION_REVIEW_AND_RECOMMENDATIONS.md)** - Comprehensive documentation review and recommendations
- **[Quick Fixes](DOCUMENTATION_QUICK_FIXES.md)** - Critical fixes checklist
---
## 📐 Architecture & Design
### Core Architecture
- **[ARCHITECTURE.md](architecture/ARCHITECTURE.md)** - System architecture overview
- **[ARCHITECTURE_DIAGRAM.md](architecture/ARCHITECTURE_DIAGRAM.md)** - Visual architecture diagrams
- **[SERVICES_ARCHITECTURE.md](architecture/SERVICES_ARCHITECTURE.md)** - Off-chain services architecture
- **[NETWORK.md](architecture/NETWORK.md)** - Network topology and design
- **[DOCKER_COMPOSE_GUIDE.md](DOCKER_COMPOSE_GUIDE.md)** - Docker Compose structure and usage
### Azure Infrastructure
- **[MULTI_REGION_VALIDATOR_DEPLOYMENT.md](azure/MULTI_REGION_VALIDATOR_DEPLOYMENT.md)** - Multi-region deployment guide
- **[GEO-AWARE-COMMITTEE-CONFIG.md](azure/GEO-AWARE-COMMITTEE-CONFIG.md)** - Geographic configuration
- **[KUBERNETES-36REGION-MAPPING.md](azure/KUBERNETES-36REGION-MAPPING.md)** - Kubernetes region mapping
- **[QUOTA_ISSUE_RESOLUTION.md](azure/QUOTA_ISSUE_RESOLUTION.md)** - Azure quota resolution
---
## ⚙️ Configuration
### Configuration Guides
- **[Configuration Index](configuration/CONFIGURATION_INDEX.md)** - Which configuration guide to use
- **[Network Configuration Guide](configuration/NETWORK_CONFIGURATION_GUIDE.md)** - Besu network configuration
- **[Azure/Cloudflare Environment Setup](configuration/AZURE_CLOUDFLARE_ENV_SETUP.md)** - Azure and Cloudflare environment variables
- **[Contract Deployment Environment Setup](configuration/CONTRACT_DEPLOYMENT_ENV_SETUP.md)** - Contract deployment environment variables
- **[Azure Naming Convention (3 Char)](configuration/AZURE_NAMING_CONVENTION_3CHAR.md)** - Standard 3-character region codes
- **[Azure Naming Convention (2-3 Char)](configuration/AZURE_NAMING_CONVENTION_2CHAR.md)** - Alternative 2-3 character region codes
- **[CONFIGURATION_FIXES_APPLIED.md](configuration/CONFIGURATION_FIXES_APPLIED.md)** - Configuration fixes
### Consensus
- **Current**: QBFT (Quorum Byzantine Fault Tolerance)
- **Previous**: IBFT 2.0 (archived)
- See [PROJECT_OPTIMIZATION_STATUS.md](PROJECT_OPTIMIZATION_STATUS.md) for migration details
---
## 🚢 Deployment
### Deployment Guides
- **[Deployment Index](deployment/DEPLOYMENT_INDEX.md)** - Which deployment guide to use
- **[DEPLOYMENT_CHECKLIST.md](deployment/DEPLOYMENT_CHECKLIST.md)** - Deployment checklist
- **[DEPLOYMENT_STATUS_AND_NEXT_STEPS.md](deployment/DEPLOYMENT_STATUS_AND_NEXT_STEPS.md)** - Current deployment status
- **[VM_DEPLOYMENT.md](deployment/VM_DEPLOYMENT.md)** - VM deployment guide
- **[36-REGION-BLUEPRINT.md](deployment/36-REGION-BLUEPRINT.md)** - 36-region deployment blueprint
- **[DEPLOYMENT_CONFIGURATION_AUDIT.md](deployment/DEPLOYMENT_CONFIGURATION_AUDIT.md)** - Configuration audit
---
## 🔧 Operations
### Runbooks
- **[Runbooks Index](runbooks/RUNBOOKS_INDEX.md)** - Index of all operational runbooks
- **[Runbooks](../runbooks/)** - Operational procedures and runbooks
### Status Reports
- **[Status Reports Index](operations/status-reports/STATUS_REPORTS_INDEX.md)** - Index of all status reports
- **[Status Reports](operations/status-reports/)** - Current operational status reports
- [COMMANDS_INDEX.md](operations/status-reports/COMMANDS_INDEX.md)
- [SCRIPTS_INDEX.md](operations/status-reports/SCRIPTS_INDEX.md)
- [PROJECT_REVIEW.md](operations/status-reports/PROJECT_REVIEW.md)
- [REVIEW_AND_RECOMMENDATIONS.md](operations/status-reports/REVIEW_AND_RECOMMENDATIONS.md)
### Monitoring
- **[Monitoring Setup Guide](operations/MONITORING_SETUP_GUIDE.md)** - Monitoring stack setup and configuration
### Integrations
- **[Integrations Index](operations/integrations/INTEGRATIONS_INDEX.md)** - Index of all integrations
- **[CCIP Integration](operations/integrations/CCIP_INTEGRATION.md)** - CCIP integration guide
- **[MetaMask Integration](operations/integrations/METAMASK_INTEGRATION.md)** - MetaMask integration guide
- **[Firefly Integration](operations/integrations/FIREFLY_INTEGRATION.md)** - Firefly integration
- **[Cacti Integration](operations/integrations/CACTI_INTEGRATION.md)** - Cacti integration
- **[METAMASK_BD.md](operations/integrations/METAMASK_BD.md)** - MetaMask integration details
- **[Crypto.com OTC Integration](../../dbis_core/src/core/exchange/crypto-com-otc/README.md)** - Crypto.com OTC 2.0 API for institutional trading (DBIS Core)
- **[Exchange Registry](../../dbis_core/src/core/exchange/)** - Multi-exchange price API (Binance, Kraken, Oanda, FXCM)
- **[Ramp API](../../metamask-integration/src/ramps/)** - Fiat on/off-ramp session API (MoonPay, Ramp, Onramper, etc.)
- **[DeFi Router](../../alltra-lifi-settlement/src/payments/)** - 1inch, ParaSwap, 0x DEX aggregator
---
## 📚 Guides
- **[Getting Started](guides/GETTING_STARTED.md)** - Getting started for different user types
- **[INTEGRATION_GUIDE.md](guides/INTEGRATION_GUIDE.md)** - Integration guide
- **[TROUBLESHOOTING.md](guides/TROUBLESHOOTING.md)** - Troubleshooting guide
- **[QUICKSTART.md](guides/QUICKSTART.md)** - Detailed quick start guide
- **[Makefile Usage](guides/MAKEFILE_USAGE.md)** - Makefile usage guide
- **[FAQ](guides/FAQ.md)** - Frequently asked questions
- **[Best Practices](guides/BEST_PRACTICES.md)** - Best practices guide
- **[Testing Guide](guides/TESTING_GUIDE.md)** - Testing infrastructure guide
- **[Automated Link Checking](guides/AUTOMATED_LINK_CHECKING.md)** - Link checking guide
## 📡 API Documentation
- **[API Reference](api/API_REFERENCE.md)** - Complete JSON-RPC API reference
- **[API.md](api/API.md)** - API overview
- **[BLOCKSCOUT_API.md](api/BLOCKSCOUT_API.md)** - Blockscout API
- **[TATUM_SDK.md](api/TATUM_SDK.md)** - Tatum SDK integration
### Templates
- **[New Guide Template](templates/NEW_GUIDE_TEMPLATE.md)** - Template for new guides
- **[Status Report Template](templates/STATUS_REPORT_TEMPLATE.md)** - Template for status reports
- **[Deployment Guide Template](templates/DEPLOYMENT_GUIDE_TEMPLATE.md)** - Template for deployment guides
- **[API Reference Template](templates/API_REFERENCE_TEMPLATE.md)** - Template for API references
---
## 🧪 Testing & Quality
- **[E2E_TESTING_REPORT.md](E2E_TESTING_REPORT.md)** - End-to-end testing report
- **[E2E_TESTING_AND_DEPLOYMENT_STATUS.md](E2E_TESTING_AND_DEPLOYMENT_STATUS.md)** - E2E testing status
- **[FINAL_E2E_REPORT_AND_RECOMMENDATIONS.md](FINAL_E2E_REPORT_AND_RECOMMENDATIONS.md)** - Final E2E report
---
## 🏛️ Governance
- **[CHANGELOG.md](governance/CHANGELOG.md)** - Project changelog
- **[Documentation Style Guide](governance/DOCUMENTATION_STYLE_GUIDE.md)** - Documentation style guide
- **[Documentation Review Schedule](governance/DOCUMENTATION_REVIEW_SCHEDULE.md)** - Review schedule and process
- **[Documentation Metrics](governance/DOCUMENTATION_METRICS.md)** - Documentation metrics and tracking
---
## 🧹 Project Optimization
### Cleanup & Deduplication
- **[PROJECT_OPTIMIZATION_STATUS.md](PROJECT_OPTIMIZATION_STATUS.md)** - Current optimization status
- **[CLEANUP_PLAN.md](CLEANUP_PLAN.md)** - Cleanup and optimization plan
- **[CLEANUP_DEDUPLICATION_REPORT.md](CLEANUP_DEDUPLICATION_REPORT.md)** - Script and documentation deduplication analysis
- **[CLEANUP_SUMMARY_2025_11_18.md](CLEANUP_SUMMARY_2025_11_18.md)** - Cleanup summary and statistics
- **[CLEANUP_COMPLETE.md](CLEANUP_COMPLETE.md)** - Cleanup completion report
- **[CLEANUP_STATS.md](CLEANUP_STATS.md)** - Cleanup statistics
---
## 📦 Archive
- **[Archive README](archive/README.md)** - Archived files documentation
- **[Archive Policy](archive/ARCHIVE_POLICY.md)** - Archive retention policy and process
- **[Archive Status Reports](archive/status-reports/)** - Historical status reports
- **[Archive Old Configs](archive/old-configs/)** - Previous configuration structures
---
## 📊 Status & Reports
### Current Status
- **[COMPLETE_STATUS_REPORT.md](COMPLETE_STATUS_REPORT.md)** - Complete status report
- **[DEPLOYMENT_STATUS_AND_NEXT_STEPS.md](DEPLOYMENT_STATUS_AND_NEXT_STEPS.md)** - Deployment status
### Task Lists
- **[PARALLEL_COMPLETION_TASK_LIST.md](PARALLEL_COMPLETION_TASK_LIST.md)** - Full parallel completion task list
- **[TODO.md](operations/tasks/TODO.md)** - Current TODO list
---
## 🔍 Finding Documentation
### By Topic
**Deployment**
- Quick Start: [DEPLOYMENT_QUICK_START.md](DEPLOYMENT_QUICK_START.md)
- Checklist: [DEPLOYMENT_CHECKLIST.md](deployment/DEPLOYMENT_CHECKLIST.md)
- Status: [DEPLOYMENT_STATUS_AND_NEXT_STEPS.md](DEPLOYMENT_STATUS_AND_NEXT_STEPS.md)
**Configuration**
- Index: [Configuration Index](configuration/CONFIGURATION_INDEX.md)
- Network: [Network Configuration Guide](configuration/NETWORK_CONFIGURATION_GUIDE.md)
- Azure/Cloudflare: [Azure/Cloudflare Environment Setup](configuration/AZURE_CLOUDFLARE_ENV_SETUP.md)
- Contracts: [Contract Deployment Environment Setup](configuration/CONTRACT_DEPLOYMENT_ENV_SETUP.md)
- Docker Compose: [DOCKER_COMPOSE_GUIDE.md](DOCKER_COMPOSE_GUIDE.md)
**Architecture**
- Overview: [ARCHITECTURE.md](architecture/ARCHITECTURE.md)
- Network: [NETWORK.md](architecture/NETWORK.md)
**Operations**
- Runbooks: [../runbooks/](../runbooks/)
- Status Reports: [operations/status-reports/](operations/status-reports/)
**Troubleshooting**
- Guide: [TROUBLESHOOTING.md](guides/TROUBLESHOOTING.md)
- Integration: [INTEGRATION_GUIDE.md](guides/INTEGRATION_GUIDE.md)
### By File Type
**Markdown Files**: All documentation is in Markdown format (.md)
**Scripts**: See [SCRIPTS_INDEX.md](operations/status-reports/SCRIPTS_INDEX.md)
**Commands**: See [COMMANDS_INDEX.md](operations/status-reports/COMMANDS_INDEX.md)
---
## 📝 Documentation Standards
- All documentation is in Markdown format
- Documentation is organized by topic in subdirectories
- Status reports are in `docs/operations/status-reports/`
- Archived documentation is in `docs/archive/`
- Guides are in `docs/guides/`
---
## 🔄 Recent Updates
**2025-01-27**:
- Comprehensive documentation review completed
- Fixed all broken links in README.md
- Created Makefile usage guide
- Created runbooks index
- Created integrations index
- Created security scanning guide
- Created monitoring setup guide
- Added Terraform and SDK documentation references
- Added glossary and API reference
- Added architecture diagrams
- Created documentation templates
- Established review schedule and archive policy
- All critical, high, medium, and low priority items complete
**2025-11-18**:
- Created master documentation index
- Updated IBFT references to QBFT
- Consolidated deployment scripts
- Archived 52+ status reports
- Created unified deployment scripts
---
## 📞 Getting Help
1. **Quick Start**: See [README.md](../README.md)
2. **Deployment Issues**: See [DEPLOYMENT_QUICK_START.md](DEPLOYMENT_QUICK_START.md)
3. **Configuration**: See [Configuration Index](configuration/CONFIGURATION_INDEX.md)
4. **Troubleshooting**: See [TROUBLESHOOTING.md](guides/TROUBLESHOOTING.md)
5. **Operations**: See [runbooks/](../runbooks/)
---
**Last Updated**: 2025-01-27
**Maintained By**: Project Team
**Version**: 1.1
## 📋 Documentation Review
- **[Documentation Review & Recommendations](DOCUMENTATION_REVIEW_AND_RECOMMENDATIONS.md)** - Comprehensive documentation review
- **[Documentation Quick Fixes](DOCUMENTATION_QUICK_FIXES.md)** - Critical fixes checklist
- **[Documentation Gap Analysis](DOCUMENTATION_GAP_ANALYSIS.md)** - Gap analysis and recommendations
- **[Final Gap Analysis and Fixes](FINAL_GAP_ANALYSIS_AND_FIXES.md)** - Final gap analysis summary
- **[Comprehensive Documentation Review](COMPREHENSIVE_DOCUMENTATION_REVIEW.md)** - Complete review report
- **[All Additional Suggestions Complete](ALL_ADDITIONAL_SUGGESTIONS_COMPLETE.md)** - Additional suggestions completion
- **[Remaining TODO Items](REMAINING_TODO_ITEMS.md)** - Remaining TODO items
- **[Implementation Summary](IMPLEMENTATION_SUMMARY.md)** - Implementation summary
- **[All TODO Items Complete](ALL_TODO_ITEMS_COMPLETE.md)** - Completion summary
- **[Final Completion Report](FINAL_COMPLETION_REPORT.md)** - Final completion report
## 📖 Reference
- **[Glossary](GLOSSARY.md)** - Technical terms glossary
- **[API Reference](api/API_REFERENCE.md)** - Complete API reference
## 🛠️ Infrastructure
### Terraform
- **[Terraform README](../terraform/README.md)** - Terraform documentation and usage
### SDK
- **[SDK README](../sdk/README.md)** - Tatum SDK integration documentation
Reference in New Issue View Git Blame Copy Permalink