# sdelquin/aprendepython architecture

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

- Interactive diagram: https://gitdiagram.com/sdelquin/aprendepython
- Repository: https://github.com/sdelquin/aprendepython

## Overview

##### Project type and purpose
- This is a “Docs-as-Code” project: a statically generated documentation site (“Aprende Python”) built with MkDocs and served as a modern, free web guide.
- The README confirms it’s a tutorial manual covering Python fundamentals, stdlib modules, and third-party packages, rendered via a static site.

##### File structure
- Top-level artifacts:
- mkdocs.yml / pyproject.toml / justfile → configuration & build scripts
- docs/ → all Markdown content (organized by topic) + assets (CSS, JS, images)
- includes/ → shared snippets (e.g., abbreviations)
- .github/workflows/ci.yml → CI/CD pipeline
- Dockerfile → containerized build environment
- CHANGELOG.md, .gitignore, .prettierignore → project housekeeping
- Pattern: “content (docs + includes) → static site generator (MkDocs) → CI build → deployment hosting”

##### README for additional insights
- Confirms static-site use (“all resources available via web”), free, modern design, levels of learning.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Source Repository"
        docs["Markdown: docs/"]:::source
        includes["Includes: includes/"]:::source
        assets_css["CSS: docs/assets/css/custom.css"]:::source
        assets_js_clip["JS: docs/assets/js/clipboard.js"]:::source
        assets_js_math["JS: docs/assets/js/mathjax.js"]:::source
        config_mk["Config: mkdocs.yml"]:::source
        config_py["Config: pyproject.toml"]:::source
        config_just["Config: justfile"]:::source
        lockfile["Dependencies: uv.lock"]:::source
        changelog["Changelog: CHANGELOG.md"]:::source
    end

    subgraph "Build Environment"
        docker["Dockerfile"]:::build
        localcli["Local Build: Python & MkDocs CLI"]:::build
    end

    ci["CI/CD Pipeline: .github/workflows/ci.yml"]:::build

    subgraph "Static Site Generator"
        mkplugins["MkDocs Engine + Plugins"]:::build
    end

    output["Generated Site (HTML/CSS/JS)"]:::output
    hosting["Hosting: GitHub Pages/CDN"]:::output
    browser["End-User Browser"]:::external

    %% Data Flow
    docs -->|push| ci
    includes -->|push| ci
    assets_css -->|push| ci
    assets_js_clip -->|push| ci
    assets_js_math -->|push| ci
    config_mk -->|push| ci
    config_py -->|push| ci
    config_just -->|push| ci
    lockfile -->|push| ci
    changelog -->|push| ci

    ci -->|triggers build| docker
    ci -->|triggers build| localcli
    localcli -->|runs MkDocs| mkplugins
    docker -->|runs MkDocs| mkplugins
    mkplugins -->|outputs static site| output
    output -->|deploys| hosting
    browser -->|requests pages| hosting
    browser -->|loads assets| output

    %% Click Events
    click docs "https://github.com/sdelquin/aprendepython/tree/main/docs/"
    click includes "https://github.com/sdelquin/aprendepython/tree/main/includes/"
    click assets_css "https://github.com/sdelquin/aprendepython/blob/main/docs/assets/css/custom.css"
    click assets_js_clip "https://github.com/sdelquin/aprendepython/blob/main/docs/assets/js/clipboard.js"
    click assets_js_math "https://github.com/sdelquin/aprendepython/blob/main/docs/assets/js/mathjax.js"
    click config_mk "https://github.com/sdelquin/aprendepython/blob/main/mkdocs.yml"
    click config_py "https://github.com/sdelquin/aprendepython/blob/main/pyproject.toml"
    click config_just "https://github.com/sdelquin/aprendepython/tree/main/justfile"
    click lockfile "https://github.com/sdelquin/aprendepython/blob/main/uv.lock"
    click changelog "https://github.com/sdelquin/aprendepython/blob/main/CHANGELOG.md"
    click docker "https://github.com/sdelquin/aprendepython/tree/main/Dockerfile"
    click ci "https://github.com/sdelquin/aprendepython/blob/main/.github/workflows/ci.yml"
    click mkplugins "https://github.com/sdelquin/aprendepython/blob/main/mkdocs.yml"

    %% Styles
    classDef source fill:#D0E8FF,stroke:#0366d6,color:#000;
    classDef build fill:#FFD8A8,stroke:#d97706,color:#000;
    classDef output fill:#D0FFD8,stroke:#059669,color:#000;
    classDef external fill:#E0E0E0,stroke:#6b7280,color:#000;
```
