# swisskyrepo/hardwareallthethings architecture

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

- Interactive diagram: https://gitdiagram.com/swisskyrepo/hardwareallthethings
- Repository: https://github.com/swisskyrepo/hardwareallthethings

## Overview

##### Project type and purpose
- This is a static documentation website built with MkDocs.
- Purpose: a community-driven “Hardware All The Things” wiki for hardware/IoT security payloads, bypasses, guides, and reference material.

##### File structure
- Top-level:
- .github/ – CI workflows & configs
- docs/ – Markdown source, subfolders by topic (gadgets, protocols, etc.), CSS overrides, assets
- mkdocs.yml – MkDocs configuration
- overrides/ – custom HTML templates for styling
- README.md, LICENSE

- Patterns and roles:
- docs/ holds all content; MkDocs reads these files to generate static HTML
- .github/workflows/ defines two pipelines:
– check-markdown.yml (linting)
– mkdocs-build.yml (build & deploy)

##### README for additional insights
- Confirms static site for hardware security knowledge
- Points to GitHub Pages deployment via MkDocs

##### Detail without over-complication
- Break out sub-components only where it adds clarity (e.g., separate Linter & Build workflows).
- Every logical step in the content → website pipeline.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Nodes
    Author["Author Workstation"]:::dev
    GitHubRepo["GitHub Repository (Source Control)"]:::repo
    subgraph "Markdown Source Content"
        DocsRoot["/docs/"]:::content
        subgraph "Content Subdirectories"
            Gadgets["gadgets"]:::content
            Protocols["protocols"]:::content
            Firmware["firmware"]:::content
            Debug["debug-interfaces"]:::content
            Enumeration["enumeration"]:::content
            Other["other"]:::content
            RF["radio-frequency"]:::content
            SecureBoot["secure-boot"]:::content
            SideChannel["side-channel"]:::content
        end
        CustomCSS["custom.css"]:::content
        Assets["assets"]:::content
    end
    MkdocsConfig["mkdocs.yml"]:::config
    MarkdownLintConfig[".markdownlint.json"]:::config
    README["README.md"]:::meta
    LICENSE["LICENSE"]:::meta
    Templates["main.html"]:::content
    subgraph "CI/CD Pipelines"
        Lint["Markdown Linter Workflow"]:::process
        Build["MkDocs Build & Deploy Workflow"]:::process
    end
    SSG["MkDocs Static Site Generator"]:::process
    Pages["GitHub Pages / CDN"]:::host
    Browser["End-User Browser"]:::client

    %% Relationships
    Author -->|"push"| GitHubRepo
    GitHubRepo -->|"trigger"| Lint
    GitHubRepo -->|"trigger"| Build
    Build -->|"uses SSG"| SSG
    SSG -->|"deploy site"| Pages
    Browser -->|"HTTP GET"| Pages

    %% Containment & References
    GitHubRepo --> DocsRoot
    GitHubRepo --> MkdocsConfig
    GitHubRepo --> MarkdownLintConfig
    GitHubRepo --> README
    GitHubRepo --> LICENSE
    GitHubRepo --> Templates

    Build --> DocsRoot
    Build --> MkdocsConfig
    Build --> Templates
    Build --> Assets

    %% Click Events
    click GitHubRepo "https://github.com/swisskyrepo/hardwareallthethings/tree/main//"
    click DocsRoot "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/"
    click Gadgets "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/gadgets/"
    click Protocols "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/protocols/"
    click Firmware "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/firmware/"
    click Debug "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/debug-interfaces/"
    click Enumeration "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/enumeration/"
    click Other "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/other/"
    click RF "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/radio-frequency/"
    click SecureBoot "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/secure-boot/"
    click SideChannel "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/side-channel/"
    click CustomCSS "https://github.com/swisskyrepo/hardwareallthethings/blob/main//docs/custom.css"
    click Assets "https://github.com/swisskyrepo/hardwareallthethings/tree/main//docs/assets/"
    click MkdocsConfig "https://github.com/swisskyrepo/hardwareallthethings/blob/main//mkdocs.yml"
    click MarkdownLintConfig "https://github.com/swisskyrepo/hardwareallthethings/blob/main//.github/.markdownlint.json"
    click Lint "https://github.com/swisskyrepo/hardwareallthethings/blob/main//.github/workflows/check-markdown.yml"
    click Build "https://github.com/swisskyrepo/hardwareallthethings/blob/main//.github/workflows/mkdocs-build.yml"
    click README "https://github.com/swisskyrepo/hardwareallthethings/blob/main//README.md"
    click LICENSE "https://github.com/swisskyrepo/hardwareallthethings/tree/main//LICENSE"
    click Templates "https://github.com/swisskyrepo/hardwareallthethings/blob/main//overrides/main.html"

    %% Styles
    classDef dev fill:#E0F7FA,stroke:#0288D1
    classDef repo fill:#BBDEFB,stroke:#1976D2
    classDef process fill:#C8E6C9,stroke:#388E3C
    classDef config fill:#DCEDC8,stroke:#558B2F
    classDef content fill:#FFF9C4,stroke:#FBC02D
    classDef host fill:#FFE0B2,stroke:#F57C00
    classDef client fill:#E1BEE7,stroke:#8E24AA
    classDef meta fill:#CFD8DC,stroke:#455A64
```
