# frankframework/frank-manual architecture

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

- Interactive diagram: https://gitdiagram.com/frankframework/frank-manual
- Repository: https://github.com/frankframework/frank-manual

## Overview

##### Content Management Layer
- RST Source Files (in /docs/source)
- Configuration Files
- Example Frank Configs (in /src and /srcSteps)
- Images and Media Assets

##### Build Processing Layer
- Python Processing Scripts
- generateAll.py (main orchestrator)
- buildDownloadZips.py (zip file generator)
- createSnippets.py (snippet generator)
- TutorialSteps Module (Python package for processing tutorials)
- Build Configuration Files

##### Output Generation Layer
- Sphinx Documentation Generator
- ReadTheDocs Integration
- ZIP File Generation
- Snippet Generation

##### Deployment Layer
- GitHub Repository
- ReadTheDocs.io Platform
- Automated Build Hooks

- [Content Management] → [Build Processing] → [Output Generation] → [Deployment]

##### Component Representations
- Rectangles: Major system components
- Rounded rectangles: Processing units
- Hexagons: External services/platforms

##### Following relationships
- Content files → Python processors
- Python processors → Generated artifacts
- Generated artifacts → Sphinx
- Sphinx → ReadTheDocs
- GitHub → ReadTheDocs hooks

##### The integration with external platforms

This system design will help developers understand the documentation generation pipeline and how different components interact to produce the final documentation website.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Content Management Layer
    subgraph CML["Content Management Layer"]
        RST["RST Documentation"]
        CONF["Configuration Files"]
        FRANK["Example Frank Configs"]
        MEDIA["Media Assets"]
    end

    %% Build Processing Layer
    subgraph BPL["Build Processing Layer"]
        GEN["Main Build Script"]
        ZIP["ZIP Generator"]
        SNIP["Snippet Generator"]
        TUT["Tutorial Processing Module"]
        BCONF["Build Configuration"]
    end

    %% Output Generation Layer
    subgraph OGL["Output Generation Layer"]
        SPHINX["Sphinx Build Directory"]
        DOWNLOADS["Generated Downloads"]
        SNIPPETS["Generated Snippets"]
        REQS["Build Requirements"]
    end

    %% Deployment Layer
    subgraph DL["Deployment Layer"]
        GH["GitHub Workflows"]
        RTD["ReadTheDocs Config"]
        HOOKS["Build Hooks"]
    end

    %% Relationships
    RST --> GEN
    CONF --> GEN
    FRANK --> GEN
    MEDIA --> SPHINX

    GEN --> |Triggers| ZIP
    GEN --> |Triggers| SNIP
    GEN --> |Triggers| TUT
    BCONF --> GEN

    ZIP --> DOWNLOADS
    SNIP --> SNIPPETS
    TUT --> SPHINX

    SPHINX --> RTD
    GH --> HOOKS
    HOOKS --> RTD

    %% Click Events
    click RST "https://github.com/frankframework/frank-manual/tree/master/docs/source"
    click CONF "https://github.com/frankframework/frank-manual/blob/master/docs/source/conf.py"
    click FRANK "https://github.com/frankframework/frank-manual/tree/master/src"
    click MEDIA "https://github.com/frankframework/frank-manual/tree/master/docs/source/_static"
    click GEN "https://github.com/frankframework/frank-manual/blob/master/generateAll.py"
    click ZIP "https://github.com/frankframework/frank-manual/blob/master/buildDownloadZips.py"
    click SNIP "https://github.com/frankframework/frank-manual/blob/master/createSnippets.py"
    click TUT "https://github.com/frankframework/frank-manual/tree/master/TutorialSteps"
    click BCONF "https://github.com/frankframework/frank-manual/blob/master/buildspec.yml"
    click SPHINX "https://github.com/frankframework/frank-manual/tree/master/docs"
    click DOWNLOADS "https://github.com/frankframework/frank-manual/tree/master/docs/source/downloads"
    click SNIPPETS "https://github.com/frankframework/frank-manual/tree/master/docs/source/snippets"
    click REQS "https://github.com/frankframework/frank-manual/blob/master/docs/requirements.txt"
    click GH "https://github.com/frankframework/frank-manual/tree/master/.github/workflows"
    click RTD "https://github.com/frankframework/frank-manual/blob/master/.readthedocs.yaml"
    click HOOKS "https://github.com/frankframework/frank-manual/blob/master/.github/workflows/frank-runner-example-cited-correctly.yml"

    %% Styling
    classDef content fill:#a8d1f0,stroke:#333,stroke-width:2px
    classDef processing fill:#90EE90,stroke:#333,stroke-width:2px
    classDef output fill:#FFB347,stroke:#333,stroke-width:2px
    classDef deployment fill:#DDA0DD,stroke:#333,stroke-width:2px

    class RST,CONF,FRANK,MEDIA content
    class GEN,ZIP,SNIP,TUT,BCONF processing
    class SPHINX,DOWNLOADS,SNIPPETS,REQS output
    class GH,RTD,HOOKS deployment

    %% Legend
    subgraph Legend
        L1[Content Management]:::content
        L2[Processing Components]:::processing
        L3[Output Components]:::output
        L4[Deployment Components]:::deployment
    end
```
