# eka-care/eka-docs architecture

> Architecture diagram of the GitHub repository eka-care/eka-docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/eka-care/eka-docs
- Repository: https://github.com/eka-care/eka-docs

## Overview

##### Project type and purpose
- This is a *static documentation website* built with the Mintlify framework.
- Its purpose is to organize and publish developer documentation (SDK guides, API references, cookbooks, user guides, etc.) for the EKA platform.

##### File structure
- Top‐level files:
- `mint.json` – Mintlify site configuration
- `README.md` – how to develop and deploy
- `.gitignore`
- Content directories (each holds `.mdx`, `.yaml`, `.yml`):
- SDKs/ – platform-specific SDK guides (Android, iOS, web, backend)
- api-reference/ – REST/API docs organized by domain
- cookbook/ – “what’s possible” recipe guides
- eka-medai/, eka-sdk/, essentials/, user-guides/ – thematic documentation sections
- images/, logo/ – static assets
- snippets/ – reusable code snippets
- No “frontend/” or “backend/” code directories: the entire repo is content for static‐site generation.

##### README for additional insights
- Uses the Mintlify CLI (`mintlify dev`) to preview locally.
- Uses a GitHub App for CI/CD: on push to default branch, docs get built and deployed automatically.
- Deployment target is the Mintlify hosting platform (behind a CDN).

##### Detail reminder
- Every major piece: content folders, the build tool, CI/CD trigger, hosting layer.
- Even though it’s a simple static-site flow, diagramming each component makes the architecture crystal clear.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% GitHub Repository with Content
    subgraph "GitHub Repository"
        direction TB
        SDKGuides["SDK Guides"]:::content
        APIReference["API Reference"]:::content
        Cookbook["Cookbook Recipes"]:::content
        EKAMedAI["EKA-MedAI Docs"]:::content
        EKASDK["EKA SDK Guides"]:::content
        Essentials["Essentials"]:::content
        UserGuides["User Guides"]:::content
        Snippets["Code Snippets"]:::content
        StaticAssets["Static Assets"]:::content
        Logo["Logo Assets"]:::content
        Introduction["introduction.mdx"]:::content
        Quickstart["quickstart.mdx"]:::content
        GettingStarted["getting-started.mdx"]:::content
        MintConfig["mint.json"]:::ci
        README["README.md"]:::ci
    end

    %% Build & CI/CD
    subgraph "Build & CI/CD"
        direction TB
        GitHubApp["Mintlify GitHub App"]:::ci
        Install["mintlify install"]:::ci
        Build["mintlify build"]:::ci
    end

    %% Hosting & Delivery
    subgraph "Hosting & Delivery"
        direction TB
        Hosting["Mintlify Hosting"]:::host
        CDN["Content Delivery Network (CDN)"]:::host
    end

    %% End User
    Browser["Developer Browser"]:::user

    %% Connections
    SDKGuides & APIReference & Cookbook & EKAMedAI & EKASDK & Essentials & UserGuides & Snippets & StaticAssets & Logo & Introduction & Quickstart & GettingStarted & MintConfig & README -->|push commits| GitHubApp
    GitHubApp -->|trigger build| Install
    Install -->|build docs| Build
    Build -->|deploy artifacts| Hosting
    Hosting -->|cache assets| CDN
    CDN -->|serve pages| Browser
    Browser -->|request docs| CDN

    %% Click Events
    click SDKGuides "https://github.com/eka-care/eka-docs/tree/main/SDKs/"
    click APIReference "https://github.com/eka-care/eka-docs/tree/main/api-reference/"
    click Cookbook "https://github.com/eka-care/eka-docs/tree/main/cookbook/"
    click EKAMedAI "https://github.com/eka-care/eka-docs/tree/main/eka-medai/"
    click EKASDK "https://github.com/eka-care/eka-docs/tree/main/eka-sdk/"
    click Essentials "https://github.com/eka-care/eka-docs/tree/main/essentials/"
    click UserGuides "https://github.com/eka-care/eka-docs/tree/main/user-guides/"
    click Snippets "https://github.com/eka-care/eka-docs/tree/main/snippets/"
    click StaticAssets "https://github.com/eka-care/eka-docs/tree/main/images/"
    click Logo "https://github.com/eka-care/eka-docs/tree/main/logo/"
    click MintConfig "https://github.com/eka-care/eka-docs/blob/main/mint.json"
    click README "https://github.com/eka-care/eka-docs/blob/main/README.md"

    %% Styles
    classDef content fill:#e2f7e2,stroke:#2d7a2d,stroke-width:1px
    classDef ci fill:#e2ecfa,stroke:#356fb2,stroke-width:1px
    classDef host fill:#fff4e5,stroke:#d97706,stroke-width:1px
    classDef user fill:#f0f0f0,stroke:#6b7280,stroke-width:1px
```
