# matanfield/docs architecture

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

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

## Overview

##### Main Components

a) Documentation Structure Layer
- Content Repository (MDX files)
- API Reference System
- Asset Management (images, snippets)
- Configuration System (mint.json)

b) Development Infrastructure
- Local Development Server
- CLI Tool Interface
- Build System

c) Deployment Layer
- GitHub Integration
- Auto-deployment System
- Production Environment

**┌─────────────────────────────────────────────────────────┐**
- Content Layer                          │
- ┬─────────────────┬─────────────────┬────┤
- MDX Content   │ API Reference   │ Assets          │    │
- Essentials  │ - Endpoints     │ - Images        │    │
- Guides      │ - OpenAPI Spec  │ - Snippets      │    │
- ┬───────┴────────┬────────┴────────┬────────┘    │

**┌───────▼───────────────▼─────────────────▼──────────┐   │**
- Configuration Layer                  │   │
- (mint.json)                      │   │
- ┬──────────────────────────┬─┘   │

**┌───────────────────────▼──────────────┐ ┌────────▼──────▼─┐**
- Development Environment        │ │   Production     │
- Mintlify CLI                       │ │   Environment    │
- Local Preview Server               │ │ - GitHub App     │
- ┘ │ - Auto Deploy   │
- ┘

##### Key Relationships to Highlight

- How the mint.json configuration file orchestrates all components
- Content pipeline from local development to production
- Demonstrate the relationship between API reference and documentation
- How assets are integrated into the content structure

##### Important Details

- File type indicators (.mdx, .json)
- Component version information
- Integration points with external services (GitHub)
- Build and deployment flow directions

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph CL["Content Layer"]
        direction TB
        MDX["MDX Content"]
        API["API Reference"]
        Assets["Asset Management"]
        
        subgraph MDXContent["Content Structure"]
            direction TB
            Essentials["Essentials Documentation"]
            Guides["Guides & Tutorials"]
            Intro["Introduction"]
        end
        
        subgraph APIRef["API Documentation"]
            direction TB
            Endpoints["API Endpoints"]
            OpenAPI["OpenAPI Specification"]
        end
        
        subgraph AssetMgmt["Assets"]
            direction TB
            Images["Images"]
            Snippets["Code Snippets"]
            Logo["Logo Files"]
        end
    end

    subgraph Config["Configuration Layer"]
        direction TB
        MintJSON["mint.json Configuration"]
        Settings["Settings Management"]
    end

    subgraph Dev["Development Environment"]
        direction TB
        CLI["Mintlify CLI"]
        LocalServer["Local Preview Server"]
        DevDocs["Development Guide"]
    end

    subgraph Prod["Production Environment"]
        direction TB
        GitHub["GitHub Integration"]
        AutoDeploy["Auto-deployment System"]
    end

    MDXContent --> MDX
    APIRef --> API
    AssetMgmt --> Assets
    
    MDX --> MintJSON
    API --> MintJSON
    Assets --> MintJSON
    
    MintJSON --> Dev
    MintJSON --> Prod

    click Essentials "https://github.com/matanfield/docs/tree/main/essentials/"
    click Intro "https://github.com/matanfield/docs/blob/main/introduction.mdx"
    click Endpoints "https://github.com/matanfield/docs/tree/main/api-reference/endpoint/"
    click OpenAPI "https://github.com/matanfield/docs/blob/main/api-reference/openapi.json"
    click Images "https://github.com/matanfield/docs/tree/main/images/"
    click Snippets "https://github.com/matanfield/docs/tree/main/snippets/"
    click Logo "https://github.com/matanfield/docs/tree/main/logo/"
    click MintJSON "https://github.com/matanfield/docs/blob/main/mint.json"
    click Settings "https://github.com/matanfield/docs/blob/main/essentials/settings.mdx"
    click DevDocs "https://github.com/matanfield/docs/blob/main/development.mdx"

    classDef content fill:#3b82f6,stroke:#1d4ed8,color:#fff
    classDef config fill:#22c55e,stroke:#15803d,color:#fff
    classDef dev fill:#f97316,stroke:#c2410c,color:#fff
    classDef prod fill:#a855f7,stroke:#7e22ce,color:#fff
    
    class MDX,API,Assets,MDXContent,APIRef,AssetMgmt,Essentials,Guides,Intro,Endpoints,OpenAPI,Images,Snippets,Logo content
    class MintJSON,Settings,Config config
    class CLI,LocalServer,DevDocs dev
    class GitHub,AutoDeploy,Prod prod
```
