# epam/ai-dial architecture

> Architecture diagram of the GitHub repository epam/ai-dial, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/epam/ai-dial
- Repository: https://github.com/epam/ai-dial

## Overview

##### Project type and purpose
- This repository is a documentation website for the DIAL platform.
- It uses a static-site generator (Docusaurus + Quarto transformers in Node.js/React) to turn markdown and Jupyter notebooks into a browsable site.
- The docs cover architecture, tutorials, examples (dial-cookbook, dial-docker-compose), and link out to other DIAL micro-repos (core, SDK, chat UI, adapters).

##### File structure
- Top-level config and metadata:
- .github/ (GitHub Actions workflows for CI/CD)
- package.json, package-lock.json, babel.config.js, docusaurus.config.js, sidebars.js (SSG and build configs)
- .quarto.yml (Quarto site config)
- Content sources:
- dial-cookbook/, dial-docker-compose/, dial-sdk/ (submodules supplying code samples, Docker-Compose examples, SDK reference)
- Build assets:
- src/ (custom scripts & markdown transformers)
- static/ (images, robots.txt, CNAME, metaschema.json)
- src/css (custom site styling)
- CI & release:
- .github/workflows/pr.yml (build & lint on PR)
- .github/workflows/release.yml (deploy on push to main)

##### README for additional insights
- Confirms this is the “DIAL Documentation” site.
- Points to an “Architecture Overview” doc under docs/platform/0.architecture-and-concepts.
- Documents how to run things locally, use Helm charts, and links out to all related DIAL repos.

## Diagram (Mermaid)

```mermaid
graph TD
    %% Actors
    Dev[/"Developers\/Contributors"/]:::user
    Browser[["End Users Browser"]]:::user

    %% GitHub
    GitHub["GitHub (Repo)"]:::service

    %% CI/CD
    CI["CI/CD Pipeline\n(GitHub Actions)"]:::ci

    %% SSG Build Engine
    subgraph "Static-Site Generator (SSG)" 
        direction TB
        Docusaurus["Docusaurus SSG\n(React, Node.js)"]:::service
        Quarto["Quarto Processor\n(.quarto.yml)"]:::service
        subgraph "Custom Transformers & Scripts"
            direction TB
            Jupyter["jupyter.js"]:::service
            OEmbed["oembed.js"]:::service
            Optanon["optanonWrapper.js"]:::service
        end
        CSS["custom.css"]:::service
    end

    %% Content Sources
    subgraph "Content Repositories" 
        direction TB
        Docs["docs/"]:::content
        Cookbook["dial-cookbook/"]:::content
        DockerCompose["dial-docker-compose/"]:::content
        SDK["dial-sdk/"]:::content
    end

    %% Config & Assets
    subgraph "Configs & Assets"
        direction TB
        DConfig["docusaurus.config.js"]:::content
        Sidebars["sidebars.js"]:::content
        Babel["babel.config.js"]:::content
        QuartoYML[".quarto.yml"]:::content
        StaticAssets["static/"]:::content
        PackageJSON["package.json"]:::content
        PackageLock["package-lock.json"]:::content
    end

    %% Hosting
    Hosting["Hosting / CDN\n(GitHub Pages / Netlify)"]:::hosting

    %% Connections
    Dev -->|"push commits"| GitHub
    GitHub -->|"triggers"| CI
    CI -->|"runs build"| Docusaurus
    Docusaurus --> Quarto
    Quarto --> Jupyter
    Quarto --> OEmbed
    Docusaurus --> Optanon
    Docusaurus --> CSS
    CI -->|"loads configs"| DConfig
    CI --> Sidebars
    CI --> Babel
    CI --> QuartoYML
    CI --> PackageJSON
    CI --> PackageLock
    CI --> StaticAssets
    Docs --> Docusaurus
    Cookbook --> Docusaurus
    DockerCompose --> Docusaurus
    SDK --> Docusaurus
    Docusaurus --> Hosting
    Hosting --> Browser

    %% Click Events
    click Docs "https://github.com/epam/ai-dial/tree/main/docs/"
    click Cookbook "https://github.com/epam/ai-dial/tree/main/dial-cookbook/"
    click DockerCompose "https://github.com/epam/ai-dial/tree/main/dial-docker-compose/"
    click SDK "https://github.com/epam/ai-dial/tree/main/dial-sdk/"
    click DConfig "https://github.com/epam/ai-dial/blob/main/docusaurus.config.js"
    click Sidebars "https://github.com/epam/ai-dial/blob/main/sidebars.js"
    click Babel "https://github.com/epam/ai-dial/blob/main/babel.config.js"
    click QuartoYML "https://github.com/epam/ai-dial/blob/main/.quarto.yml"
    click Jupyter "https://github.com/epam/ai-dial/blob/main/src/transformers/jupyter.js"
    click OEmbed "https://github.com/epam/ai-dial/blob/main/src/transformers/oembed.js"
    click Optanon "https://github.com/epam/ai-dial/blob/main/src/scripts/optanonWrapper.js"
    click CSS "https://github.com/epam/ai-dial/blob/main/src/css/custom.css"
    click StaticAssets "https://github.com/epam/ai-dial/tree/main/static/"
    click PackageJSON "https://github.com/epam/ai-dial/blob/main/package.json"
    click PackageLock "https://github.com/epam/ai-dial/blob/main/package-lock.json"
    click CI "https://github.com/epam/ai-dial/blob/main/.github/workflows/pr.yml"
    click CI "https://github.com/epam/ai-dial/blob/main/.github/workflows/release.yml"
    click GitHub "https://github.com/epam/ai-dial/tree/main/.github/"

    %% Styles
    classDef content fill:#E0F7FA,stroke:#006064,color:#006064
    classDef service fill:#FFECB3,stroke:#FF6F00,color:#BF360C
    classDef ci fill:#FFE0B2,stroke:#F57C00,color:#E65100
    classDef hosting fill:#C8E6C9,stroke:#2E7D32,color:#1B5E20
    classDef user fill:#E0E0E0,stroke:#616161,color:#424242
```
