Skip to content

Visual Diagrams (Mermaid)

This folder contains Mermaid diagrams that visualize how the codebase is structured, how data flows through the system, and where failure paths trigger fail-fast behavior. These diagrams are intended to be read alongside docs/Architecture.md and docs/overview.md.

If your Markdown viewer supports Mermaid, the diagrams render inline. If it does not, copy the Mermaid blocks into a Mermaid-compatible editor.

Index

  • docs/visuals/system_overview.md describes the end-to-end system shape.
  • docs/visuals/store.md focuses on src/fyers_store/store.py.
  • docs/visuals/broker.md focuses on src/fyers_store/broker.py.
  • docs/visuals/data_feed.md focuses on src/fyers_store/data_feed.py.
  • docs/visuals/historical_cache.md focuses on src/fyers_store/persistence/.
  • docs/visuals/adapters.md focuses on src/fyers_store/adapters/.
  • docs/visuals/state_persistence.md focuses on src/fyers_store/state/.
  • docs/visuals/config_and_utilities.md maps configuration files and helper modules to their consumers.
  • docs/visuals/logging.md explains logging categories and file targets.