# ftc32477/quick-start-guide architecture

> Architecture diagram of the GitHub repository ftc32477/quick-start-guide, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ftc32477/quick-start-guide
- Repository: https://github.com/ftc32477/quick-start-guide

## Overview

This repository is a multilingual guide publishing system: maintainers author Markdown and shared images, build.py generates the language portal and guide pages, and build_pdf.py exports print-ready PDFs from those pages. Readers enter through the language portal, browse localized chapters and version history, or access published PDFs. The README documents PDF layout, font subsets, and release links. Source excerpts are partial, so edges for documented build and navigation behavior rely on the README where appropriate; unsampled implementation details are not inferred.

Main entry points: [`dist/en-us/index.html`](https://github.com/ftc32477/quick-start-guide/blob/main/dist/en-us/index.html) (Language home), [`build_pdf.py`](https://github.com/ftc32477/quick-start-guide/blob/main/build_pdf.py) (PDF exporter), [`build.py`](https://github.com/ftc32477/quick-start-guide/blob/main/build.py) (HTML builder), [`fonts/build_subsets.py`](https://github.com/ftc32477/quick-start-guide/blob/main/fonts/build_subsets.py) (Subset generator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_content["Guide content"]
  node_markdown["Localized Markdown"]
  node_images["Shared images"]
end

subgraph group_web["Web publishing"]
  node_htmlbuilder["HTML builder<br/>[build.py]"]
  node_portal["Language portal<br/>[index.html]"]
  node_home["Language home<br/>[index.html]"]
  node_chapters["Guide chapters"]
  node_history["Version history<br/>[versions.html]"]
end

subgraph group_pdf["PDF export"]
  node_pdfbuilder["PDF exporter<br/>[build_pdf.py]"]
  node_pdfs["Guide PDFs"]
end

subgraph group_fonts["PDF fonts"]
  node_fontsubsets["Font subsets"]
  node_subsettool["Subset generator<br/>[build_subsets.py]"]
end

node_reader(("Reader"))
node_maintainer(("Maintainer"))
node_browser["Chrome or Edge"]

node_reader -->|"opens"| node_portal
node_portal -->|"selects language"| node_home
node_maintainer -->|"edits"| node_markdown
node_markdown -->|"provides content"| node_htmlbuilder
node_images -->|"provides assets"| node_htmlbuilder
node_htmlbuilder -->|"generates"| node_portal
node_htmlbuilder -->|"generates"| node_home
node_htmlbuilder -->|"renders pages"| node_chapters
node_home -->|"navigates to"| node_chapters
node_home -->|"links to"| node_history
node_reader -->|"opens"| node_home
node_maintainer -->|"runs export"| node_pdfbuilder
node_pdfbuilder -->|"renders pages"| node_browser
node_pdfbuilder -->|"reads HTML"| node_home
node_pdfbuilder -->|"loads fonts"| node_fontsubsets
node_pdfbuilder -->|"writes PDFs"| node_pdfs
node_maintainer -.->|"runs when needed"| node_subsettool
node_subsettool -->|"generates subsets"| node_fontsubsets
node_subsettool -->|"checks coverage"| node_pdfbuilder
node_home -->|"links release PDFs"| node_pdfs

click node_markdown "https://github.com/ftc32477/quick-start-guide/tree/main/src"
click node_images "https://github.com/ftc32477/quick-start-guide/tree/main/images"
click node_htmlbuilder "https://github.com/ftc32477/quick-start-guide/blob/main/build.py"
click node_portal "https://github.com/ftc32477/quick-start-guide/blob/main/dist/index.html"
click node_home "https://github.com/ftc32477/quick-start-guide/blob/main/dist/en-us/index.html"
click node_chapters "https://github.com/ftc32477/quick-start-guide/tree/main/src/en-us"
click node_history "https://github.com/ftc32477/quick-start-guide/blob/main/dist/en-us/versions.html"
click node_pdfbuilder "https://github.com/ftc32477/quick-start-guide/blob/main/build_pdf.py"
click node_fontsubsets "https://github.com/ftc32477/quick-start-guide/tree/main/fonts/subsets"
click node_subsettool "https://github.com/ftc32477/quick-start-guide/blob/main/fonts/build_subsets.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_markdown,node_images toneBlue
class node_htmlbuilder,node_portal,node_home,node_chapters,node_history toneAmber
class node_pdfbuilder,node_pdfs toneMint
class node_fontsubsets,node_subsettool toneRose
class node_reader,node_maintainer,node_browser toneIndigo
```

## Components

### Guide content

- [Localized Markdown](https://github.com/ftc32477/quick-start-guide/tree/main/src): `src`
- [Shared images](https://github.com/ftc32477/quick-start-guide/tree/main/images): `images`

### Web publishing

- [HTML builder](https://github.com/ftc32477/quick-start-guide/blob/main/build.py): `build.py`
- [Language portal](https://github.com/ftc32477/quick-start-guide/blob/main/dist/index.html): `dist/index.html`
- [Language home](https://github.com/ftc32477/quick-start-guide/blob/main/dist/en-us/index.html): `dist/en-us/index.html`
- [Guide chapters](https://github.com/ftc32477/quick-start-guide/tree/main/src/en-us): `src/en-us`
- [Version history](https://github.com/ftc32477/quick-start-guide/blob/main/dist/en-us/versions.html): `dist/en-us/versions.html`

### PDF export

- [PDF exporter](https://github.com/ftc32477/quick-start-guide/blob/main/build_pdf.py): `build_pdf.py`
- **Guide PDFs**

### PDF fonts

- [Font subsets](https://github.com/ftc32477/quick-start-guide/tree/main/fonts/subsets): `fonts/subsets`
- [Subset generator](https://github.com/ftc32477/quick-start-guide/blob/main/fonts/build_subsets.py): `fonts/build_subsets.py`

### Other components

- **Reader**
- **Maintainer**
- **Chrome or Edge**

## Connections

- Reader → Language portal: opens (evidence: `README.md`)
- Language portal → Language home: selects language (evidence: `README.md`)
- Maintainer → Localized Markdown: edits (evidence: `README.md`)
- Localized Markdown → HTML builder: provides content (evidence: `README.md`)
- Shared images → HTML builder: provides assets (evidence: `README.md`)
- HTML builder → Language portal: generates (evidence: `README.md`)
- HTML builder → Language home: generates (evidence: `README.md`)
- HTML builder → Guide chapters: renders pages (evidence: `README.md`)
- Language home → Guide chapters: navigates to
- Language home → Version history: links to
- Reader → Language home: opens (evidence: `README.md`)
- Maintainer → PDF exporter: runs export (evidence: `README.md`)
- PDF exporter → Chrome or Edge: renders pages (evidence: `README.md`)
- PDF exporter → Language home: reads HTML (evidence: `build_pdf.py`)
- PDF exporter → Font subsets: loads fonts (evidence: `README.md`)
- PDF exporter → Guide PDFs: writes PDFs (evidence: `README.md`)
- Maintainer → Subset generator: runs when needed (evidence: `README.md`)
- Subset generator → Font subsets: generates subsets (evidence: `fonts/build_subsets.py`)
- Subset generator → PDF exporter: checks coverage (evidence: `fonts/build_subsets.py`)
- Language home → Guide PDFs: links release PDFs
