# lxveace/cyber-controller-guides architecture

> Architecture diagram of the GitHub repository lxveace/cyber-controller-guides, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lxveace/cyber-controller-guides
- Repository: https://github.com/lxveace/cyber-controller-guides

## Overview

This repository is a curated collection of hardware and operating-system walkthroughs, rather than the Cyber Controller flashing application itself. A reader uses the README to choose a target, follows its guide through purchasing/building/flashing/integration/troubleshooting, and can use a corresponding printable PDF. The README documents broad target categories and PDF availability. Sampled source confirms the content index and PDF generation behavior; guide-specific workflows and wiring data were not sampled, so those links are represented only where the README supports them.

Main entry points: [`guides`](https://github.com/lxveace/cyber-controller-guides/tree/main/guides) (Hardware walkthroughs), [`tools/build_readme.py`](https://github.com/lxveace/cyber-controller-guides/blob/main/tools/build_readme.py) (Catalog renderer), [`README.md`](https://github.com/lxveace/cyber-controller-guides/blob/main/README.md) (Target catalog), [`pdf`](https://github.com/lxveace/cyber-controller-guides/tree/main/pdf) (Printable PDFs)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_catalog["Guide catalog"]
  node_catalog["Target catalog<br/>[README.md]"]
  node_metadata["Project metadata<br/>[projects.json]"]
  node_buildreadme["Catalog renderer<br/>[build_readme.py]"]
end

subgraph group_content["Guide content"]
  node_guides["Hardware walkthroughs"]
  node_wiring["Wiring data<br/>[wiring.json]"]
end

subgraph group_print["Printable guides"]
  node_pdfs["Printable PDFs"]
  node_pdfbuilder["PDF renderer<br/>[build_pdfs.py]"]
end

node_reader(("Guide reader"))
node_cybercontroller["Cyber Controller"]
node_hardware["Target hardware"]

node_reader -->|"browses"| node_catalog
node_catalog -->|"links guides"| node_guides
node_catalog -->|"links PDFs"| node_pdfs
node_buildreadme -->|"reads metadata"| node_metadata
node_buildreadme -->|"indexes guides"| node_guides
node_buildreadme -->|"checks PDFs"| node_pdfs
node_buildreadme -->|"renders index"| node_catalog
node_reader -->|"follows walkthrough"| node_guides
node_guides -->|"explains building"| node_hardware
node_guides -->|"explains integration"| node_cybercontroller
node_pdfbuilder -->|"converts Markdown"| node_guides
node_pdfbuilder -->|"reads metadata"| node_metadata
node_pdfbuilder -->|"writes PDFs"| node_pdfs
node_reader -->|"downloads"| node_pdfs

click node_catalog "https://github.com/lxveace/cyber-controller-guides/blob/main/README.md"
click node_metadata "https://github.com/lxveace/cyber-controller-guides/blob/main/data/projects.json"
click node_guides "https://github.com/lxveace/cyber-controller-guides/tree/main/guides"
click node_buildreadme "https://github.com/lxveace/cyber-controller-guides/blob/main/tools/build_readme.py"
click node_wiring "https://github.com/lxveace/cyber-controller-guides/blob/main/data/wiring.json"
click node_pdfs "https://github.com/lxveace/cyber-controller-guides/tree/main/pdf"
click node_pdfbuilder "https://github.com/lxveace/cyber-controller-guides/blob/main/tools/build_pdfs.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_catalog,node_metadata,node_buildreadme toneBlue
class node_guides,node_wiring toneAmber
class node_pdfs,node_pdfbuilder toneMint
class node_reader,node_cybercontroller,node_hardware toneIndigo
```

## Components

### Guide catalog

- [Target catalog](https://github.com/lxveace/cyber-controller-guides/blob/main/README.md): `README.md`
- [Project metadata](https://github.com/lxveace/cyber-controller-guides/blob/main/data/projects.json): `data/projects.json`
- [Catalog renderer](https://github.com/lxveace/cyber-controller-guides/blob/main/tools/build_readme.py): `tools/build_readme.py`

### Guide content

- [Hardware walkthroughs](https://github.com/lxveace/cyber-controller-guides/tree/main/guides): `guides`
- [Wiring data](https://github.com/lxveace/cyber-controller-guides/blob/main/data/wiring.json): `data/wiring.json`

### Printable guides

- [Printable PDFs](https://github.com/lxveace/cyber-controller-guides/tree/main/pdf): `pdf`
- [PDF renderer](https://github.com/lxveace/cyber-controller-guides/blob/main/tools/build_pdfs.py): `tools/build_pdfs.py`

### Other components

- **Guide reader**
- **Cyber Controller**
- **Target hardware**

## Connections

- Guide reader → Target catalog: browses (evidence: `README.md`)
- Target catalog → Hardware walkthroughs: links guides (evidence: `README.md`)
- Target catalog → Printable PDFs: links PDFs (evidence: `README.md`)
- Catalog renderer → Project metadata: reads metadata (evidence: `tools/build_readme.py`)
- Catalog renderer → Hardware walkthroughs: indexes guides (evidence: `tools/build_readme.py`)
- Catalog renderer → Printable PDFs: checks PDFs (evidence: `tools/build_readme.py`)
- Catalog renderer → Target catalog: renders index (evidence: `tools/build_readme.py`)
- Guide reader → Hardware walkthroughs: follows walkthrough (evidence: `README.md`)
- Hardware walkthroughs → Target hardware: explains building (evidence: `README.md`)
- Hardware walkthroughs → Cyber Controller: explains integration (evidence: `README.md`)
- PDF renderer → Hardware walkthroughs: converts Markdown (evidence: `tools/build_pdfs.py`)
- PDF renderer → Project metadata: reads metadata (evidence: `tools/build_pdfs.py`)
- PDF renderer → Printable PDFs: writes PDFs (evidence: `tools/build_pdfs.py`)
- Guide reader → Printable PDFs: downloads (evidence: `README.md`)
