# luismayta/resume architecture

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

- Interactive diagram: https://gitdiagram.com/luismayta/resume
- Repository: https://github.com/luismayta/resume

## Overview

##### Project Type and Purpose
- This is a static document‐generation tool (a LaTeX‐based resume template) that uses a multi‐language task runner and CI/CD workflows to produce a PDF.
- Key use case: edit sections, assets, or config; run `task resume`; produce `resume.pdf`.

##### File Structure
- Top‐level folders:
– assets (fonts, images)
– core (LaTeX classes & packages)
– config (TeX configuration fragments)
– sections & sidebars (content snippets)
– data (bibliography files)
– docs (project documentation, mkdocs config)
- Other artifacts: Taskfile.yml (task runner), pyproject.toml (Python tooling), .goji.json, .terraform‐version, Dockerignore, GitHub Actions workflows.

##### README for Additional Insights
- It calls out usage of:
– Task CLI (`task setup`, `task start`, `task resume`)
– XeLaTeX (document compilation)
– Docker & Pyenv (environment isolation)
- CI steps: lint, test, release, and build resume on push.

##### Main Components & Their Relationships
a. Developer Workstation
– Task Runner (Taskfile.yml) invokes subtasks:
- Environment Provisioning (Docker container, Python virtualenv, Goji?)
- LaTeX Compilation (XeLaTeX + core classes + config + assets + content)
– Source Folders: core, config, assets, sections, sidebars, data
– Output: resume.pdf
b. Continuous Integration (GitHub Actions)
– Lint Job (runs linters in `.ci/linters`)
– Test Job (verification of build, maybe syntax checks, PDF existence)
– Release Job (uses goreleaser, semantic‐release)
– Documentation Site (mkdocs build, deployment)
c. External Services & Tools
– Docker Hub (for pulling images)
– PyPI (for Python tasks, e.g., Sphinx or other doc generators)
– PlantUML server (optional)
– GitHub (source repo, issues, PRs)

##### Architectural Patterns & Design Principles
- Pipeline Orchestration: tasks are decoupled into “provision”, “build”, “package”
- Separation of Concerns:
– Content vs. Layout (sections vs. core classes)
– Configuration vs. Code (config folder vs. provision templates)
– CI vs. Local Dev (GitHub workflows vs. local Task CLI)
- Extensibility: new tasks, templates, sections can be plugged via provision/generators

##### Elements
- Clear Labels: “Task Runner”, “XeLaTeX Engine”, “Assets”, “Core Classes”, “Sections”, “CI Lint/Test/Release”
– Rectangles for components (folders, tools)
– Clouds for external services (Docker Hub, GitHub)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Environment
    subgraph "Developer Environment"
        direction TB
        subgraph "Source Folders"
            direction TB
            assets["assets/"]:::folder
            core["core/"]:::folder
            config["config/"]:::folder
            sections["sections/"]:::folder
            sidebars["sidebars/"]:::folder
            data["data/"]:::folder
            resumeTex["resume.tex"]:::file
            assets --> TaskRunner
            core --> TaskRunner
            config --> TaskRunner
            sections --> TaskRunner
            sidebars --> TaskRunner
            data --> TaskRunner
            resumeTex --> TaskRunner
        end

        TaskRunner["Task Runner"]:::task
        TaskRunner --> EnvProv

        subgraph "Environment Provisioning"
            direction TB
            DockerTask["Docker Task"]:::task
            PythonTask["Python Task"]:::task
            GoTask["Go Task"]:::task
            GitTask["Git Task"]:::task
            GojiConfig[".goji.json"]:::file
            Envrc[".envrc"]:::file
            DockerTask --> DiagramGen
            PythonTask --> DiagramGen
            GoTask --> DiagramGen
            GitTask --> DiagramGen
            GojiConfig --> DockerTask
            Envrc --> DockerTask
        end
        EnvProv --> DockerTask
        EnvProv --> PythonTask
        EnvProv --> GoTask
        EnvProv --> GitTask
        EnvProv --> GojiConfig
        EnvProv --> Envrc

        subgraph "Diagram Generation"
            direction TB
            PlantTask["PlantUML Task"]:::task
            PUMLFiles["*.plantuml"]:::file
            PlantTask --> LaTeX
            PUMLFiles --> PlantTask
        end
        DiagramGen["Diagram Generation\n(PlantUML)"]:::task
        EnvProv --> DiagramGen
        DiagramGen --> PlantTask
        DiagramGen --> PUMLFiles

        subgraph "LaTeX Compilation"
            direction TB
            XeLaTeXTask["XeLaTeX Task"]:::task
            resumePDF["resume.pdf"]:::artifact
            XeLaTeXTask --> resumePDF
        end
        LaTeX["XeLaTeX Compilation"]:::task
        PlantTask --> LaTeX
        LaTeX --> XeLaTeXTask
        resumeTex --> XeLaTeXTask
    end

    %% CI/CD Pipeline
    subgraph "CI/CD Pipeline"
        direction TB
        Actions["GitHub Actions"]:::ci
        Lint["Lint Job"]:::ci
        Test["Test Job"]:::ci
        ResumeBuild["Build Resume"]:::ci
        Release["Release Job"]:::ci
        Artifact["Upload Artifacts"]:::ci

        Actions --> Lint --> Test --> ResumeBuild --> Artifact
        ResumeBuild --> TaskRunner
        ResumeBuild --> LaTeX
    end

    %% External Services
    subgraph "External Services"
        direction TB
        GH["GitHub Repo"]:::external
        DockerHub["Docker Hub"]:::external
        PyPI["PyPI"]:::external
        PlantUMLSrv["PlantUML Server"]:::external

        GH --> Actions
        DockerHub --> DockerTask
        PyPI --> PythonTask
        PlantUMLSrv --> PUMLFiles
    end

    %% Click Events
    click TaskRunner "https://github.com/luismayta/resume/blob/main/Taskfile.yml"
    click DockerTask "https://github.com/luismayta/resume/blob/main/provision/task/docker.yml"
    click PythonTask "https://github.com/luismayta/resume/blob/main/provision/task/python.yml"
    click GoTask "https://github.com/luismayta/resume/blob/main/provision/task/go.yml"
    click GitTask "https://github.com/luismayta/resume/blob/main/provision/task/git.yml"
    click GojiConfig "https://github.com/luismayta/resume/blob/main/.goji.json"
    click Envrc "https://github.com/luismayta/resume/blob/main/.envrc"
    click PlantTask "https://github.com/luismayta/resume/blob/main/provision/task/plantuml.yml"
    click PUMLFiles "https://github.com/luismayta/resume/tree/main/provision/diagrams/docs/diagrams/"
    click XeLaTeXTask "https://github.com/luismayta/resume/blob/main/provision/task/xelatex.yml"
    click resumeTex "https://github.com/luismayta/resume/blob/main/resume.tex"
    click assets "https://github.com/luismayta/resume/tree/main/assets/"
    click core "https://github.com/luismayta/resume/tree/main/core/"
    click config "https://github.com/luismayta/resume/tree/main/config/"
    click sections "https://github.com/luismayta/resume/tree/main/sections/"
    click sidebars "https://github.com/luismayta/resume/tree/main/sidebars/"
    click data "https://github.com/luismayta/resume/tree/main/data/"
    click Lint "https://github.com/luismayta/resume/blob/main/.github/workflows/lint.yml"
    click Test "https://github.com/luismayta/resume/tree/main/.ci/linters/"
    click ResumeBuild "https://github.com/luismayta/resume/blob/main/.github/workflows/resume.yml"
    click Release "https://github.com/luismayta/resume/blob/main/.github/workflows/release.yml"
    click Artifact "https://github.com/luismayta/resume/tree/main/docs/"
    click GH "https://github.com/luismayta/resume/blob/main/."

    %% Styles
    classDef folder fill:#D6E9F8,stroke:#31708F,color:#31708F
    classDef file fill:#E2F0D9,stroke:#3C763D,color:#3C763D
    classDef task fill:#FCF8E3,stroke:#8A6D3B,color:#8A6D3B
    classDef artifact fill:#FAEBCC,stroke:#8A6D3B,color:#8A6D3B
    classDef ci fill:#F2DEDE,stroke:#A94442,color:#A94442
    classDef external fill:#F5ECCE,stroke:#8C6D1F,color:#8C6D1F
```
