dbis_core/docs/VISUAL_INDEX.md

# DBIS Core Banking System - Visual Index

This document provides a comprehensive index of all visual diagrams and visualizations in the DBIS Core Banking System documentation.

## Diagram Legend

### Diagram Types

- **Mermaid Diagrams**: Interactive diagrams that render in Markdown viewers
- **ASCII Diagrams**: Text-based diagrams (legacy format, maintained for compatibility)
- **Architecture Diagrams**: System architecture and component relationships
- **Sequence Diagrams**: Process flows and interactions
- **Flow Diagrams**: Business process flows
- **State Diagrams**: State machines and transitions

## Main Documentation

### README.md

- [System Architecture Overview](../README.md#system-architecture-overview) - Mermaid diagram
- [Project Structure](../README.md#project-structure) - Mermaid diagram
- [Quick Start Flow](../README.md#quick-start-flow) - Mermaid sequence diagram
- [Technology Stack](../README.md#technology-stack) - Mermaid diagram

## Architecture Documentation

### Architecture Atlas

- [DBIS Core Governance & Master Ledger](./architecture-atlas.md#1-dbis-core-governance--master-ledger)
  - Core Macro Diagram (Mermaid)
  - Key Flows Sequence Diagram (Mermaid)
  
- [Sovereign Layer](./architecture-atlas.md#2-sovereign-layer-33-central-banks--private-banking-tier)
  - Sovereign Layer Topology (Mermaid)
  - SCB Registration Flow (Mermaid)
  
- [Global Settlement & Payments](./architecture-atlas.md#3-global-settlement--payments-fabric-gss-gpn-gas-m-rtgs)
  - Integrated Flow Diagram (Mermaid)
  
- [FX, SSU, and GRU Systems](./architecture-atlas.md#4-fx-ssu-and-gru-systems)
  - FX/SSU/GRU Diagram (Mermaid)

## Flow Documentation

### Payment Flows

- [GPN Payment Flow](./flows/gpn-payment-flow.md)
  - Payment Flow Sequence Diagram (Mermaid)
  
- [GSS Settlement Flow](./flows/gss-settlement-flow.md)
  - Settlement Flow Diagram

- [M-RTGS Settlement Flow](./flows/m-rtgs-settlement-flow.md)
  - RTGS Flow Diagram

- [Atomic Settlement Flow](./flows/atomic-settlement-flow.md)
  - Atomic Settlement Sequence Diagram

### CBDC Flows

- [CBDC Mint Burn Flow](./flows/cbdc-mint-burn-flow.md)
  - Mint/Burn Flow Diagram

- [CBDC Wallet Transfer Flow](./flows/cbdc-wallet-transfer-flow.md)
  - Wallet Transfer Sequence Diagram

- [CBDC Interoperability Flow](./flows/cbdc-interoperability-flow.md)
  - Interoperability Flow Diagram

### FX & Settlement Flows

- [FX Trade Execution Flow](./flows/fx-trade-execution-flow.md)
  - FX Trade Sequence Diagram

- [SSU Mint Burn Flow](./flows/ssu-mint-burn-flow.md)
  - SSU Flow Diagram

- [SSU Atomic Settlement Flow](./flows/ssu-atomic-settlement-flow.md)
  - SSU Settlement Sequence Diagram

- [Cross-Chain Settlement Flow](./flows/cross-chain-settlement-flow.md)
  - Cross-Chain Flow Diagram

### Compliance Flows

- [AML Screening Flow](./flows/aml-screening-flow.md)
  - AML Screening Sequence Diagram

- [KYC Enforcement Flow](./flows/kyc-enforcement-flow.md)
  - KYC Flow Diagram

- [Identity Verification Flow](./flows/identity-verification-flow.md)
  - Identity Verification Sequence Diagram

- [RegTech Monitoring Flow](./flows/regtech-monitoring-flow.md)
  - RegTech Flow Diagram

## Technical Documentation

### Development Guide

- [Development Workflow](./development.md#development-workflow) - Mermaid diagram
- [Code Organization](./development.md#code-organization) - Mermaid diagram

### Deployment Guide

- [Deployment Architecture](./deployment.md#deployment-architecture) - Mermaid diagram
- [CI/CD Pipeline](./deployment.md#cicd-pipeline) - Mermaid diagram

### API Guide

- [API Architecture](./api-guide.md#api-architecture) - Mermaid diagram
- [API Request Flow](./api-guide.md#api-request-flow) - Mermaid sequence diagram
- [Authentication Flow](./api-guide.md#authentication--authorization) - Mermaid sequence diagram
- [Rate Limiting Strategy](./api-guide.md#rate-limiting) - Mermaid diagram
- [API Versioning](./api-guide.md#api-versioning) - Mermaid diagram
- [Error Handling](./api-guide.md#error-handling) - Mermaid diagram
- [API Testing Strategy](./api-guide.md#api-testing) - Mermaid diagram

### Monitoring Guide

- [Monitoring Architecture](./monitoring.md#monitoring-architecture) - Mermaid diagram
- [Key Metrics](./monitoring.md#key-metrics-to-monitor) - Mermaid diagrams
- [Database Metrics](./monitoring.md#database-metrics) - Mermaid diagram
- [Log Levels](./monitoring.md#log-levels) - Mermaid diagram
- [Alert Flow](./monitoring.md#alert-flow) - Mermaid sequence diagram

### Best Practices Guide

- [Directory Structure](./BEST_PRACTICES.md#directory-structure) - Mermaid diagram
- [Authentication & Authorization](./BEST_PRACTICES.md#authentication--authorization) - Mermaid sequence diagram
- [Database Optimization](./BEST_PRACTICES.md#database-optimization) - Mermaid diagram
- [Testing Pyramid](./BEST_PRACTICES.md#testing-pyramid) - Mermaid diagram
- [Test Organization](./BEST_PRACTICES.md#test-organization) - Mermaid diagram
- [Documentation Structure](./BEST_PRACTICES.md#documentation-structure) - Mermaid diagram
- [Deployment Architecture](./BEST_PRACTICES.md#deployment-architecture) - Mermaid diagram

### Recommendations

- [Implementation Roadmap](./RECOMMENDATIONS.md#implementation-roadmap) - Mermaid Gantt chart

## Volume Documentation

### Volume II

- [Volume II Modules](./volume-ii/README.md)
  - Module architecture diagrams
  - Integration flow diagrams

### Volume III

- [Volume III Systems](./volume-iii/README.md)
  - GSS architecture diagrams
  - CIM flow diagrams
  - SSU architecture diagrams

### Additional Volumes

- Volume IV-XIV documentation contains additional architecture and flow diagrams
- See individual volume README files for diagram listings

## Quick Navigation

### By Diagram Type

**Architecture Diagrams**:
- System Architecture Overview (README)
- Deployment Architecture (deployment.md)
- API Architecture (api-guide.md)
- Monitoring Architecture (monitoring.md)

**Sequence Diagrams**:
- Quick Start Flow (README)
- GPN Payment Flow (flows/gpn-payment-flow.md)
- API Request Flow (api-guide.md)
- Authentication Flow (api-guide.md)

**Flow Diagrams**:
- All flow documentation in `docs/flows/`
- CBDC flows
- FX flows
- Settlement flows
- Compliance flows

**State Diagrams**:
- State machine diagrams in volume documentation
- Process state diagrams in flow documentation

### By Topic

**System Architecture**:
- [README](../README.md)
- [Architecture Atlas](./architecture-atlas.md)

**Development**:
- [Development Guide](./development.md)
- [Best Practices](./BEST_PRACTICES.md)

**Deployment**:
- [Deployment Guide](./deployment.md)
- [Monitoring Guide](./monitoring.md)

**API**:
- [API Guide](./api-guide.md)

**Business Flows**:
- [Flow Documentation](./flows/README.md)

## Diagram Standards

### Mermaid Diagram Conventions

1. **Node Naming**: Use descriptive names
2. **Color Coding**: Use consistent colors for component types
3. **Direction**: Use top-to-bottom for hierarchies, left-to-right for flows
4. **Labels**: Include clear labels on all connections

### ASCII Diagram Conventions

1. **Boxes**: Use box-drawing characters
2. **Flow Direction**: Use arrows (→, ↓, ↑, ←)
3. **Branches**: Use tree structures
4. **Connections**: Use lines (│, ─, └, ┌, ┐, ┘)

## Contributing

When adding new diagrams:

1. Use Mermaid for new diagrams
2. Maintain ASCII diagrams for legacy compatibility
3. Update this index
4. Follow diagram standards
5. Include recommendations where applicable

## Related Documentation

- [Architecture Atlas](./architecture-atlas.md)
- [Flow Documentation](./flows/README.md)
- [Best Practices](./BEST_PRACTICES.md)
- [Recommendations](./RECOMMENDATIONS.md)