# logoff/ose-srd-es architecture

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

- Interactive diagram: https://gitdiagram.com/logoff/ose-srd-es
- Repository: https://github.com/logoff/ose-srd-es

## Overview

##### Main Components

a) Documentation Generation System:
- MkDocs Engine (Core)
- Markdown Content Repository
- Static Site Generator
- GitHub Pages Deployment

b) Content Management:
- Source Content Organization
- Asset Management (images)
- Styling System

**[Content Layer]**

- Markdown Files (src/)
- Game Rules
- Character Classes
- Spells
- Monsters

- Assets (src/img/)
- Images

- Styling (src/stylesheets/)
- CSS

**[Build Layer]**

- MkDocs Engine
- Configuration (mkdocs.yml)
- Build Process

**[Deployment Layer]**

- GitHub Actions
- Build Workflow

- GitHub Pages
- Hosted Documentation

##### Component Relationships

- Content files feed into MkDocs
- MkDocs processes content using configuration
- GitHub Actions triggers builds
- Built site deploys to GitHub Pages

##### Additional Elements

- A development workflow section
- Both Docker and non-Docker paths
- Testing/preview capabilities
- Content organization structure

- Clear separation of content, build, and deployment layers
- Automated workflow from content to published site
- Multiple development paths (Docker vs. non-Docker)
- Content organization structure

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Content
        MD[Markdown Content]
        GM["Game Rules"]
        CC["Character Classes"]
        SP["Spells Repository"]
        MN["Monsters Database"]
        MS["Magic System"]
        TS["Treasure System"]
        ES["Equipment System"]
        SS["Strongholds System"]
        AM["Asset Management"]
        ST["Styling System"]
    end

    subgraph Build
        ME["MkDocs Engine"]
        MC["MkDocs Config"]
        BP["Build Process"]
    end

    subgraph Deployment
        GHA["GitHub Actions"]
        GHP["GitHub Pages"]
    end

    subgraph Development
        DC["Docker Container"]
        PM["Poetry Dependencies"]
        LDS["Local Dev Server"]
    end

    %% Content Layer Relationships
    MD --> GM
    MD --> CC
    MD --> SP
    MD --> MN
    MD --> MS
    MD --> TS
    MD --> ES
    MD --> SS
    MD --> AM
    MD --> ST

    %% Build Layer Relationships
    GM & CC & SP & MN & MS & TS & ES & SS & AM & ST --> ME
    MC --> ME
    ME --> BP

    %% Deployment Layer Relationships
    BP --> GHA
    GHA --> GHP

    %% Development Layer Relationships
    DC --> ME
    PM --> ME
    ME --> LDS

    %% Component Mappings
    click GM "https://github.com/logoff/ose-srd-es/tree/main/src/01_personajes_jugadores/"
    click CC "https://github.com/logoff/ose-srd-es/tree/main/src/07_clases/"
    click SP "https://github.com/logoff/ose-srd-es/tree/main/src/13_hechizos_de_clerigo/"
    click MN "https://github.com/logoff/ose-srd-es/tree/main/src/15_monstruos/"
    click AM "https://github.com/logoff/ose-srd-es/tree/main/src/img/"
    click ST "https://github.com/logoff/ose-srd-es/tree/main/src/stylesheets/"
    click MC "https://github.com/logoff/ose-srd-es/blob/main/mkdocs.yml"
    click GHA "https://github.com/logoff/ose-srd-es/blob/main/.github/workflows/build.yml"
    click DC "https://github.com/logoff/ose-srd-es/tree/main/Dockerfile"
    click PM "https://github.com/logoff/ose-srd-es/blob/main/pyproject.toml"
    click MS "https://github.com/logoff/ose-srd-es/tree/main/src/03_magia/"
    click TS "https://github.com/logoff/ose-srd-es/tree/main/src/06_tesoros/"
    click ES "https://github.com/logoff/ose-srd-es/tree/main/src/09_equipo/"
    click SS "https://github.com/logoff/ose-srd-es/tree/main/src/12_fortalezas/"

    %% Styling
    classDef content fill:#e1f5fe,stroke:#01579b
    classDef build fill:#e8f5e9,stroke:#1b5e20
    classDef deployment fill:#fff3e0,stroke:#e65100
    classDef development fill:#f5f5f5,stroke:#424242

    class GM,CC,SP,MN,MS,TS,ES,SS,AM,ST,MD content
    class ME,MC,BP build
    class GHA,GHP deployment
    class DC,PM,LDS development
```
