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 - Mermaid diagram
• Project Structure - Mermaid diagram
• Quick Start Flow - Mermaid sequence diagram
• Technology Stack - Mermaid diagram

Architecture Documentation

Architecture Atlas

• DBIS Core Governance & Master Ledger

  • Core Macro Diagram (Mermaid)
  • Key Flows Sequence Diagram (Mermaid)

• Sovereign Layer

  • Sovereign Layer Topology (Mermaid)
  • SCB Registration Flow (Mermaid)

• Global Settlement & Payments

  • Integrated Flow Diagram (Mermaid)

• FX, SSU, and GRU Systems

  • FX/SSU/GRU Diagram (Mermaid)

Flow Documentation

Payment Flows

• GPN Payment Flow

  • Payment Flow Sequence Diagram (Mermaid)

• GSS Settlement Flow

  • Settlement Flow Diagram

• M-RTGS Settlement Flow

  • RTGS Flow Diagram

• Atomic Settlement Flow

  • Atomic Settlement Sequence Diagram

CBDC Flows

• CBDC Mint Burn Flow

  • Mint/Burn Flow Diagram

• CBDC Wallet Transfer Flow

  • Wallet Transfer Sequence Diagram

• CBDC Interoperability Flow

  • Interoperability Flow Diagram

FX & Settlement Flows

• FX Trade Execution Flow

  • FX Trade Sequence Diagram

• SSU Mint Burn Flow

  • SSU Flow Diagram

• SSU Atomic Settlement Flow

  • SSU Settlement Sequence Diagram

• Cross-Chain Settlement Flow

  • Cross-Chain Flow Diagram

Compliance Flows

• AML Screening Flow

  • AML Screening Sequence Diagram

• KYC Enforcement Flow

  • KYC Flow Diagram

• Identity Verification Flow

  • Identity Verification Sequence Diagram

• RegTech Monitoring Flow

  • RegTech Flow Diagram

Technical Documentation

Development Guide

• Development Workflow - Mermaid diagram
• Code Organization - Mermaid diagram

Deployment Guide

• Deployment Architecture - Mermaid diagram
• CI/CD Pipeline - Mermaid diagram

API Guide

• API Architecture - Mermaid diagram
• API Request Flow - Mermaid sequence diagram
• Authentication Flow - Mermaid sequence diagram
• Rate Limiting Strategy - Mermaid diagram
• API Versioning - Mermaid diagram
• Error Handling - Mermaid diagram
• API Testing Strategy - Mermaid diagram

Monitoring Guide

• Monitoring Architecture - Mermaid diagram
• Key Metrics - Mermaid diagrams
• Database Metrics - Mermaid diagram
• Log Levels - Mermaid diagram
• Alert Flow - Mermaid sequence diagram

Best Practices Guide

• Directory Structure - Mermaid diagram
• Authentication & Authorization - Mermaid sequence diagram
• Database Optimization - Mermaid diagram
• Testing Pyramid - Mermaid diagram
• Test Organization - Mermaid diagram
• Documentation Structure - Mermaid diagram
• Deployment Architecture - Mermaid diagram

Recommendations

• Implementation Roadmap - Mermaid Gantt chart

Volume Documentation

Volume II

• Volume II Modules
  • Module architecture diagrams
  • Integration flow diagrams

Volume III

• Volume III Systems
  • 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
• Architecture Atlas

Development:

• Development Guide
• Best Practices

Deployment:

• Deployment Guide
• Monitoring Guide

API:

• API Guide

Business Flows:

• Flow Documentation

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
• Flow Documentation
• Best Practices
• Recommendations