# owasp/cheatsheetseries architecture

> Architecture diagram of the GitHub repository owasp/cheatsheetseries, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/owasp/cheatsheetseries
- Repository: https://github.com/owasp/cheatsheetseries

## Overview

OWASP Cheat Sheet Series is a curated security-knowledge repository. Contributors create or revise Markdown guidance, examples, and supporting diagrams; indexes organize the published material; site tooling produces the official web and offline experiences; builders read the resulting cheat sheets. The sampled scripts also show an RSS-generation path backed by GitHub pull-request data. Some publishing internals are inferred only from README-described commands, while the content and index-generation relationships are directly evidenced.

Main entry points: [`scripts/Generate_Site.sh`](https://github.com/owasp/cheatsheetseries/blob/master/scripts/Generate_Site.sh) (Site Generator), [`cheatsheets`](https://github.com/owasp/cheatsheetseries/tree/master/cheatsheets) (Published Cheat Sheets), [`scripts/Update_CheatSheets_Index.py`](https://github.com/owasp/cheatsheetseries/blob/master/scripts/Update_CheatSheets_Index.py) (Index Generator), [`scripts/Generate_RSS_Feed.py`](https://github.com/owasp/cheatsheetseries/blob/master/scripts/Generate_RSS_Feed.py) (RSS Generator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_authoring["Content Authoring"]
  node_cheatsheets["Published Cheat Sheets"]
  node_drafts["Draft Cheat Sheets"]
  node_assets["Security Assets"]
  node_guidance["Contribution Guidance<br/>[GUIDELINE.md]"]
end

subgraph group_knowledge["Knowledge Organization"]
  node_alphabetical_index["Alphabetical Index<br/>[Index.md]"]
  node_asvs_index["ASVS Index<br/>[IndexASVS.md]"]
  node_masvs_index["MASVS Index<br/>[IndexMASVS.md]"]
  node_proactive_index["Proactive Controls Index"]
  node_index_generator["Index Generator"]
  node_toc_generator["TOC Generator"]
end

subgraph group_delivery["Publication Delivery"]
  node_site_generator["Site Generator<br/>[Generate_Site.sh]"]
  node_official_site["Official Website"]
  node_offline_bundle["Offline Website Bundle"]
end

subgraph group_operations["Project Operations"]
  node_rss_generator["RSS Generator"]
  node_news_feed["News Feed"]
end

node_contributors(("Contributors"))
node_builders(("Application Builders"))
node_github_api["GitHub API"]

node_contributors -->|"reads"| node_guidance
node_contributors -->|"proposes"| node_drafts
node_contributors -->|"edits"| node_cheatsheets
node_contributors -->|"contributes"| node_assets
node_index_generator -->|"scans"| node_cheatsheets
node_index_generator -->|"writes"| node_alphabetical_index
node_toc_generator -->|"scans"| node_cheatsheets
node_site_generator -->|"builds from"| node_cheatsheets
node_site_generator -->|"reads"| node_alphabetical_index
node_site_generator -->|"reads"| node_asvs_index
node_site_generator -->|"reads"| node_masvs_index
node_site_generator -->|"reads"| node_proactive_index
node_site_generator -->|"publishes"| node_official_site
node_site_generator -->|"packages"| node_offline_bundle
node_builders -->|"reads"| node_official_site
node_rss_generator -.->|"fetches PRs"| node_github_api
node_rss_generator -.->|"writes feed"| node_news_feed

click node_cheatsheets "https://github.com/owasp/cheatsheetseries/tree/master/cheatsheets"
click node_drafts "https://github.com/owasp/cheatsheetseries/tree/master/cheatsheets_draft"
click node_assets "https://github.com/owasp/cheatsheetseries/tree/master/assets"
click node_guidance "https://github.com/owasp/cheatsheetseries/blob/master/GUIDELINE.md"
click node_alphabetical_index "https://github.com/owasp/cheatsheetseries/blob/master/Index.md"
click node_asvs_index "https://github.com/owasp/cheatsheetseries/blob/master/IndexASVS.md"
click node_masvs_index "https://github.com/owasp/cheatsheetseries/blob/master/IndexMASVS.md"
click node_proactive_index "https://github.com/owasp/cheatsheetseries/blob/master/IndexProactiveControls.md"
click node_index_generator "https://github.com/owasp/cheatsheetseries/blob/master/scripts/Update_CheatSheets_Index.py"
click node_toc_generator "https://github.com/owasp/cheatsheetseries/blob/master/scripts/Generate_CheatSheets_TOC.py"
click node_site_generator "https://github.com/owasp/cheatsheetseries/blob/master/scripts/Generate_Site.sh"
click node_rss_generator "https://github.com/owasp/cheatsheetseries/blob/master/scripts/Generate_RSS_Feed.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_cheatsheets,node_drafts,node_assets,node_guidance toneBlue
class node_alphabetical_index,node_asvs_index,node_masvs_index,node_proactive_index,node_index_generator,node_toc_generator toneAmber
class node_site_generator,node_official_site,node_offline_bundle,node_github_api toneMint
class node_rss_generator,node_news_feed toneRose
class node_contributors,node_builders toneIndigo
```

## Components

### Content Authoring

- [Published Cheat Sheets](https://github.com/owasp/cheatsheetseries/tree/master/cheatsheets): `cheatsheets`
- [Draft Cheat Sheets](https://github.com/owasp/cheatsheetseries/tree/master/cheatsheets_draft): `cheatsheets_draft`
- [Security Assets](https://github.com/owasp/cheatsheetseries/tree/master/assets): `assets`
- [Contribution Guidance](https://github.com/owasp/cheatsheetseries/blob/master/GUIDELINE.md): `GUIDELINE.md`

### Knowledge Organization

- [Alphabetical Index](https://github.com/owasp/cheatsheetseries/blob/master/Index.md): `Index.md`
- [ASVS Index](https://github.com/owasp/cheatsheetseries/blob/master/IndexASVS.md): `IndexASVS.md`
- [MASVS Index](https://github.com/owasp/cheatsheetseries/blob/master/IndexMASVS.md): `IndexMASVS.md`
- [Proactive Controls Index](https://github.com/owasp/cheatsheetseries/blob/master/IndexProactiveControls.md): `IndexProactiveControls.md`
- [Index Generator](https://github.com/owasp/cheatsheetseries/blob/master/scripts/Update_CheatSheets_Index.py): `scripts/Update_CheatSheets_Index.py`
- [TOC Generator](https://github.com/owasp/cheatsheetseries/blob/master/scripts/Generate_CheatSheets_TOC.py): `scripts/Generate_CheatSheets_TOC.py`

### Publication Delivery

- [Site Generator](https://github.com/owasp/cheatsheetseries/blob/master/scripts/Generate_Site.sh): `scripts/Generate_Site.sh`
- **Official Website**
- **Offline Website Bundle**

### Project Operations

- [RSS Generator](https://github.com/owasp/cheatsheetseries/blob/master/scripts/Generate_RSS_Feed.py): `scripts/Generate_RSS_Feed.py`
- **News Feed**

### Other components

- **Contributors**
- **Application Builders**
- **GitHub API**

## Connections

- Contributors → Contribution Guidance: reads
- Contributors → Draft Cheat Sheets: proposes
- Contributors → Published Cheat Sheets: edits
- Contributors → Security Assets: contributes
- Index Generator → Published Cheat Sheets: scans
- Index Generator → Alphabetical Index: writes
- TOC Generator → Published Cheat Sheets: scans
- Site Generator → Published Cheat Sheets: builds from
- Site Generator → Alphabetical Index: reads
- Site Generator → ASVS Index: reads
- Site Generator → MASVS Index: reads
- Site Generator → Proactive Controls Index: reads
- Site Generator → Official Website: publishes
- Site Generator → Offline Website Bundle: packages
- Application Builders → Official Website: reads
- RSS Generator → GitHub API: fetches PRs
- RSS Generator → News Feed: writes feed
