# cuemeet/cuemeet-documentation architecture

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

- Interactive diagram: https://gitdiagram.com/cuemeet/cuemeet-documentation
- Repository: https://github.com/cuemeet/cuemeet-documentation

## Overview

##### Project Type and Purpose
- This is a static documentation website built with Docusaurus (a React-based SSG).
- It hosts CueMeet’s API references (openapi.yaml), markdown guides (docs/), custom React components (src/), and static assets (static/).

##### File-Structure Analysis
- Top-Level:
- .github/workflows – CI for PR checks and automated docs deployment
- Dockerfile – containerize the docs app
- openapi.yaml – OpenAPI spec driving API reference pages
- docs/ – markdown sources for guides & auto-generated API pages
- src/ – React components & MDX pages for custom UI
- static/ – images and other assets
- docusaurus.config.ts, sidebars.ts – site configuration & navigation
- Scripts & Config: package.json defines start/build/deploy scripts; workflows invoke those in CI.

##### Key README Insights
- Supports two dev modes: Docker‐based (`docker build` + `docker run`) and native Node.js/Yarn (`yarn start`).
- Build targets static site (`npm run build`), serve locally (`npm run serve`), and deploy (`npm run deploy`).
- The repo deploys via GitHub Actions to production (likely GH Pages or another static host).

## Diagram (Mermaid)

```mermaid
flowchart TD
  subgraph "Developer Environment" 
    Dev["Developer Workstation (IDE, Git CLI)"]:::developer
  end
  Dev -->|"git push"| Repo["GitHub Repository"]:::repo

  subgraph "CI/CD Pipeline"
    PRCheck["GitHub Actions CI (PR checks)"]:::ci
    DeployDocs["GitHub Actions CI (docs deploy)"]:::ci
  end
  Repo -->|push| PRCheck
  Repo -->|merge to main| DeployDocs

  subgraph "Build Environment"
    Docker["Docker Container"]:::container
    NodeYarn["Node.js + Yarn"]:::build
    Docusaurus["Docusaurus Engine (React + MDX)"]:::build
    OpenAPI["OpenAPI Processor"]:::build
  end
  DeployDocs --> Docker
  DeployDocs --> NodeYarn
  Docker --> NodeYarn
  NodeYarn --> Docusaurus
  NodeYarn --> OpenAPI

  subgraph "Content Sources"
    DocsDir["Markdown Guides & Docs"]:::content
    APIPages["Auto-generated API pages"]:::content
    OpenAPISpec["OpenAPI Spec (openapi.yaml)"]:::content
  end
  DocsDir --> Docusaurus
  APIPages --> Docusaurus
  OpenAPISpec --> OpenAPI

  subgraph "Site Configuration"
    DocusaurusConfig["docusaurus.config.ts"]:::config
    Sidebars["sidebars.ts"]:::config
    Package["package.json"]:::config
  end
  Package --> NodeYarn
  DocusaurusConfig --> Docusaurus
  Sidebars --> Docusaurus

  subgraph "Custom UI & Assets"
    Components["React components (src/components/)"]:::content
    MDXPages["MDX pages (src/pages/)"]:::content
    CSS["Custom CSS overrides"]:::content
    StaticFiles["Static assets (static/)"]:::content
  end
  Components --> Docusaurus
  MDXPages --> Docusaurus
  CSS --> Docusaurus
  StaticFiles --> Docusaurus

  Docusaurus -->|"build static files"| BuildOutput["Static Site Output (build/)"]:::output

  subgraph "Hosting & Delivery"
    Hosting["Hosting / CDN (GitHub Pages)"]:::hosting
  end
  BuildOutput --> Hosting
  Hosting -->|"serve docs"| Browser["End User Browser"]:::user

  click PRCheck "https://github.com/cuemeet/cuemeet-documentation/blob/main/.github/workflows/pr-check.yml"
  click DeployDocs "https://github.com/cuemeet/cuemeet-documentation/blob/main/.github/workflows/deploy-docs.yml"
  click Docker "https://github.com/cuemeet/cuemeet-documentation/tree/main/Dockerfile"
  click OpenAPISpec "https://github.com/cuemeet/cuemeet-documentation/blob/main/openapi.yaml"
  click DocsDir "https://github.com/cuemeet/cuemeet-documentation/tree/main/docs/"
  click APIPages "https://github.com/cuemeet/cuemeet-documentation/blob/main/docs/bot/*.api.mdx"
  click DocusaurusConfig "https://github.com/cuemeet/cuemeet-documentation/blob/main/docusaurus.config.ts"
  click Sidebars "https://github.com/cuemeet/cuemeet-documentation/blob/main/sidebars.ts"
  click Components "https://github.com/cuemeet/cuemeet-documentation/tree/main/src/components/"
  click MDXPages "https://github.com/cuemeet/cuemeet-documentation/tree/main/src/pages/"
  click CSS "https://github.com/cuemeet/cuemeet-documentation/blob/main/src/css/custom.css"
  click StaticFiles "https://github.com/cuemeet/cuemeet-documentation/tree/main/static/"
  click Package "https://github.com/cuemeet/cuemeet-documentation/blob/main/package.json"

  classDef developer fill:#f9f,stroke:#333,stroke-width:1px
  classDef repo fill:#bbf,stroke:#333,stroke-width:1px
  classDef ci fill:#ffb,stroke:#333,stroke-width:1px
  classDef container fill:#fbf,stroke:#333,stroke-width:1px
  classDef build fill:#bfb,stroke:#333,stroke-width:1px
  classDef content fill:#fb8,stroke:#333,stroke-width:1px
  classDef config fill:#8bf,stroke:#333,stroke-width:1px
  classDef output fill:#fc8,stroke:#333,stroke-width:1px
  classDef hosting fill:#8f8,stroke:#333,stroke-width:1px
  classDef user fill:#f88,stroke:#333,stroke-width:1px
```
