# agno-agi/agno-docs architecture

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

- Interactive diagram: https://gitdiagram.com/agno-agi/agno-docs
- Repository: https://github.com/agno-agi/agno-docs

## Overview

##### Main Components
- Documentation Content Repository – Represent the entire file tree as the “Documentation Source.” This includes directories for:
– _snippets: Reusable documentation and code snippet components.
– Various topic-based folders (agents, chunking, embedder, teams, workflows, etc.) that organize guides, references, examples, FAQs, and how-to instructions.
– Assets directories (images, videos, logo) which support the visual elements of the docs.
- Static Site Generator / Build Engine – Highlight the role of the Mintlify CLI. This tool takes the source MDX/markdown files and builds/serves the documentation site.
- Development and Preview Server – Represent the local development environment (mintlify dev running on port 3333) which enables live previewing of the documentation.
- Version Control & Publishing Mechanism – Include Git as the source of truth. Show how changes are pushed to the main branch, which triggers updates or deployments of the production site.

##### Relationships and Interactions
- The version control system (Git) feeds changes into the documentation repository, and commits/pushes trigger builds and deployments.
- Assets (images, videos) and configuration (mint.json) are inputs that the build process uses to accurately render the static site.

##### Architectural Patterns and Design Principles
- Static Site Architecture – Emphasize that the overall system is static; content is built once (or on changes) and served as a static web app.
- Developer Workflow Emphasis – Include the interactive, iterative nature of documentation updates (e.g., local dev via Mintlify CLI, then Git commit/push).

## Diagram (Mermaid)

```mermaid
graph TD
    %% Content Repository and Modules
    A["Documentation Content Repository"]:::content
    subgraph "Documentation Modules"
        B["_snippets (Reusable Content Components)"]:::content
        C1["Agents (Topic Module)"]:::content
        C2["Chunking (Topic Module)"]:::content
        C3["Embedder (Topic Module)"]:::content
        C4["Examples (Topic Module)"]:::content
        D["Assets (Supporting Assets)"]:::content
        D1["Images"]:::content
        D2["Videos"]:::content
        D3["Logo"]:::content
        E["mint.json (Build Config)"]:::content
    end

    %% Build and Deployment
    F["Mintlify CLI (Build Engine)"]:::process
    G["Development Server (mintlify dev:3333)"]:::server
    subgraph "CLI Tools"
        G1a["ag commands"]:::server
        G1b["ws commands"]:::server
    end
    H["Production Documentation Website"]:::server

    %% Version Control and CI/CD
    I["Git Repository"]:::version
    I1[".gitignore"]:::version
    J["CI/CD Pipeline"]:::process

    %% Relationships
    A -->|"feedsContent"| F
    F -->|"deploys"| H
    F -->|"livePreview"| G
    I -->|"pushTrigger"| F
    J -->|"automatedDeploy"| H

    %% Click Events
    click A "https://github.com/agno-agi/agno-docs/blob/main/."
    click B "https://github.com/agno-agi/agno-docs/tree/main/_snippets"
    click C1 "https://github.com/agno-agi/agno-docs/tree/main/agents"
    click C2 "https://github.com/agno-agi/agno-docs/tree/main/chunking"
    click C3 "https://github.com/agno-agi/agno-docs/tree/main/embedder"
    click C4 "https://github.com/agno-agi/agno-docs/tree/main/examples"
    click D1 "https://github.com/agno-agi/agno-docs/tree/main/images"
    click D2 "https://github.com/agno-agi/agno-docs/tree/main/videos"
    click D3 "https://github.com/agno-agi/agno-docs/tree/main/logo"
    click E "https://github.com/agno-agi/agno-docs/blob/main/mint.json"
    click G1a "https://github.com/agno-agi/agno-docs/tree/main/workspaces/cli/ag/"
    click G1b "https://github.com/agno-agi/agno-docs/tree/main/workspaces/cli/ws/"
    click I1 "https://github.com/agno-agi/agno-docs/blob/main/.gitignore"

    %% Styles
    classDef content fill:#E0F7FA,stroke:#006064,stroke-width:2px;
    classDef process fill:#FFF3E0,stroke:#E65100,stroke-width:2px;
    classDef server fill:#E8F5E9,stroke:#1B5E20,stroke-width:2px;
    classDef version fill:#F3E5F5,stroke:#4A148C,stroke-width:2px;
```
