# jwasham/coding-interview-university architecture

> Architecture diagram of the GitHub repository jwasham/coding-interview-university, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-04-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jwasham/coding-interview-university
- Repository: https://github.com/jwasham/coding-interview-university

## Overview

1. **Repository type**
   - This is a documentation/content repository, not an application runtime.
   - The core “product” is a long-form Markdown study guide for software engineering interview prep.

2. **Canonical source of truth**
   - `README.md` is the primary artifact and the main entry point.
   - It defines the study plan, topic progression, resource lists, and contributor guidance.
   - Most other files are supporting material rather than independent modules.

3. **Content structure**
   - The README is organized as a hierarchical curriculum: study plan, core topics, optional advanced topics, interview prep, and job search advice.
   - The structure is intentionally linear for learning flow, but the document also acts as a reference catalog.
   - This makes the repository a knowledge base with navigation anchors rather than code components.

4. **Localization layer**
   - The `translations/` directory contains language-specific copies of the README.
   - `translations/README-*.md` are localized mirrors of the main guide.
   - `translations/how-to.md` appears to support the translation workflow and contributor process.
   - Architecture-wise, these are parallel presentation layers over the same canonical content.

5. **Supplemental asset library**
   - `extras/cheat sheets/` stores static PDF references used by the guide.
   - These assets support specific topics like Big-O, bits, system design, C/C++, Java, Python, STL, and git.
   - They function as embedded reference material, not generated outputs.

6. **External dependency graph**
   - The repository is heavily link-driven: most learning material points to external videos, books, course pages, and articles.
   - The repo itself is mostly an index and curation layer over third-party educational content.
   - Diagrammatically, a large portion of the “data flow” goes outward from Markdown sections to external resources.

7. **Validation / maintenance automation**
   - `.github/workflows/links_checker.yml` provides CI automation for link validation.
   - This is the only explicit build/maintenance subsystem visible in the tree.
   - Its role is quality control: detect broken references in a repository whose value depends on link freshness.

8. **Publication model**
   - The repository is designed for GitHub-native consumption: Markdown rendering, task lists, anchors, and relative links.
   - There is no backend, API, database, or package runtime.
   - The “deployment” target is effectively the GitHub repo page itself and any forks/copies used by learners.

9. **Contribution and fork flow**
   - The README explicitly encourages forking, checking off tasks, and syncing from upstream.
   - That means the repo supports personal progress tracking through user forks, while the canonical repo remains editorial content.
   - This creates a distributed contribution model rather than a centralized app workflow.

10. **Boundaries**
   - Core boundary: canonical guide vs localized mirrors.
   - Secondary boundary: repository-managed assets vs externally hosted learning resources.
   - Operational boundary: content editing vs automated link validation.
   - There is no separation into service layers, data layers, or frontend/backend tiers because this is not a software service.

11. **Practical architecture summary**
   - Think of the repo as a curated curriculum platform built from one master Markdown document, translated derivatives, static reference PDFs, and a small CI safety net.
   - The important diagram nodes are: canonical README, translation set, cheat-sheet assets, and link-check workflow, with many outbound links to external learning providers.

Main entry points: [`README.md`](https://github.com/jwasham/coding-interview-university/blob/main/README.md) (README), [`.github/workflows/links_checker.yml`](https://github.com/jwasham/coding-interview-university/blob/main/.github/workflows/links_checker.yml) (Link checker), [`programming-language-resources.md`](https://github.com/jwasham/coding-interview-university/blob/main/programming-language-resources.md) (Resource index), [`translations/how-to.md`](https://github.com/jwasham/coding-interview-university/blob/main/translations/how-to.md) (Translation guide)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_core["Canonical guide"]
  node_readme["README<br/>canonical guide<br/>[README.md]"]
  node_curriculum["Curriculum<br/>study flow"]
  node_interview_prep["Interview prep<br/>prep section"]
  node_job_search["Job search<br/>career section"]
  node_resources_catalog["Resource index<br/>curated links"]
end

subgraph group_localization["Localization"]
  node_translations_set["Translations<br/>localized mirrors"]
  node_translation_howto["Translation guide<br/>workflow doc<br/>[how-to.md]"]
  node_readme_af["README af<br/>localized README<br/>[README-af.md]"]
  node_readme_es["README es<br/>localized README<br/>[README-es.md]"]
  node_readme_ja["README ja<br/>localized README<br/>[README-ja.md]"]
  node_readme_zh["README cn<br/>localized README<br/>[README-cn.md]"]
end

subgraph group_assets["Reference assets"]
  node_cheat_sheets[("Cheat sheets<br/>pdf library")]
  node_big_o["Big-O<br/>reference pdf"]
  node_system_design_pdf["System design<br/>reference pdf<br/>[system-design.pdf]"]
  node_python_pdf["Python sheet<br/>reference pdf"]
end

subgraph group_automation["Automation"]
  node_link_checker["Link checker<br/>ci workflow<br/>[links_checker.yml]"]
end

subgraph group_external["External learning"]
  node_external_resources(("External resources<br/>third-party content"))
end

node_readme -->|"organizes"| node_curriculum
node_readme -->|"includes"| node_interview_prep
node_readme -->|"includes"| node_job_search
node_readme -->|"references"| node_resources_catalog
node_readme -->|"mirrored by"| node_translations_set
node_translations_set -->|"guided by"| node_translation_howto
node_translations_set -->|"contains"| node_readme_af
node_translations_set -->|"contains"| node_readme_es
node_translations_set -->|"contains"| node_readme_ja
node_translations_set -->|"contains"| node_readme_zh
node_readme -->|"uses"| node_cheat_sheets
node_cheat_sheets -->|"includes"| node_big_o
node_cheat_sheets -->|"includes"| node_system_design_pdf
node_cheat_sheets -->|"includes"| node_python_pdf
node_readme -->|"links out"| node_external_resources
node_resources_catalog -->|"curates"| node_external_resources
node_link_checker -->|"validates"| node_readme
node_link_checker -->|"validates"| node_translations_set

click node_readme "https://github.com/jwasham/coding-interview-university/blob/main/README.md"
click node_resources_catalog "https://github.com/jwasham/coding-interview-university/blob/main/programming-language-resources.md"
click node_translation_howto "https://github.com/jwasham/coding-interview-university/blob/main/translations/how-to.md"
click node_readme_af "https://github.com/jwasham/coding-interview-university/blob/main/translations/README-af.md"
click node_readme_es "https://github.com/jwasham/coding-interview-university/blob/main/translations/README-es.md"
click node_readme_ja "https://github.com/jwasham/coding-interview-university/blob/main/translations/README-ja.md"
click node_readme_zh "https://github.com/jwasham/coding-interview-university/blob/main/translations/README-cn.md"
click node_big_o "https://github.com/jwasham/coding-interview-university/blob/main/extras/cheat sheets/big-o-cheatsheet.pdf"
click node_system_design_pdf "https://github.com/jwasham/coding-interview-university/blob/main/extras/cheat sheets/system-design.pdf"
click node_python_pdf "https://github.com/jwasham/coding-interview-university/blob/main/extras/cheat sheets/python-cheat-sheet-v1.pdf"
click node_link_checker "https://github.com/jwasham/coding-interview-university/blob/main/.github/workflows/links_checker.yml"

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_readme,node_curriculum,node_interview_prep,node_job_search,node_resources_catalog toneBlue
class node_translations_set,node_translation_howto,node_readme_af,node_readme_es,node_readme_ja,node_readme_zh toneAmber
class node_cheat_sheets,node_big_o,node_system_design_pdf,node_python_pdf toneMint
class node_link_checker toneRose
class node_external_resources toneIndigo
```

## Components

### Canonical guide

Primary Markdown source of truth and its major logical sections.

- [README](https://github.com/jwasham/coding-interview-university/blob/main/README.md): canonical guide · Main study guide and entry point for the repository. · `README.md`
- **Curriculum**: study flow · Linear progression through core software engineering interview topics.
- **Interview prep**: prep section · Practice, mock interviews, and preparation guidance.
- **Job search**: career section · Advice for applications, resumes, and hiring process navigation.
- [Resource index](https://github.com/jwasham/coding-interview-university/blob/main/programming-language-resources.md): curated links · Reference list of books, courses, articles, and other learning material. · `programming-language-resources.md`

### Localization

Translated mirrors and translation workflow support.

- **Translations**: localized mirrors · Language-specific copies of the canonical guide.
- [Translation guide](https://github.com/jwasham/coding-interview-university/blob/main/translations/how-to.md): workflow doc · Contributor guidance for maintaining translated copies. · `translations/how-to.md`
- [README af](https://github.com/jwasham/coding-interview-university/blob/main/translations/README-af.md): localized README · Afrikaans translation of the main guide. · `translations/README-af.md`
- [README es](https://github.com/jwasham/coding-interview-university/blob/main/translations/README-es.md): localized README · Spanish translation of the main guide. · `translations/README-es.md`
- [README ja](https://github.com/jwasham/coding-interview-university/blob/main/translations/README-ja.md): localized README · Japanese translation of the main guide. · `translations/README-ja.md`
- [README cn](https://github.com/jwasham/coding-interview-university/blob/main/translations/README-cn.md): localized README · Chinese translation of the main guide. · `translations/README-cn.md`

### Reference assets

Static cheat sheets and supplemental PDFs.

- **Cheat sheets**: pdf library · Static reference PDFs used throughout the guide.
- [Big-O](https://github.com/jwasham/coding-interview-university/blob/HEAD/extras/cheat%20sheets/big-o-cheatsheet.pdf): reference pdf · Big-O complexity cheat sheet. · `extras/cheat sheets/big-o-cheatsheet.pdf`
- [System design](https://github.com/jwasham/coding-interview-university/blob/HEAD/extras/cheat%20sheets/system-design.pdf): reference pdf · System design cheat sheet. · `extras/cheat sheets/system-design.pdf`
- [Python sheet](https://github.com/jwasham/coding-interview-university/blob/HEAD/extras/cheat%20sheets/python-cheat-sheet-v1.pdf): reference pdf · Python language cheat sheet. · `extras/cheat sheets/python-cheat-sheet-v1.pdf`

### Automation

Repository maintenance and link validation.

- [Link checker](https://github.com/jwasham/coding-interview-university/blob/main/.github/workflows/links_checker.yml): ci workflow · GitHub Actions workflow that validates repository links. · `.github/workflows/links_checker.yml`

### External learning

Third-party books, videos, courses, and articles linked from the guide.

- **External resources**: third-party content · Outward-facing learning resources referenced by the guide.

## Connections

- README → Curriculum: organizes · The README defines the learning progression.
- README → Interview prep: includes · Interview practice is a dedicated section.
- README → Job search: includes · Career guidance is part of the canonical guide.
- README → Resource index: references · The guide points to an additional curated resource list.
- README → Translations: mirrored by · Localized copies replicate the main guide.
- Translations → Translation guide: guided by · Translation workflow documentation supports the mirrors.
- Translations → README af: contains · Afrikaans mirror.
- Translations → README es: contains · Spanish mirror.
- Translations → README ja: contains · Japanese mirror.
- Translations → README cn: contains · Chinese mirror.
- README → Cheat sheets: uses · The guide embeds or links to reference PDFs.
- Cheat sheets → Big-O: includes · Big-O quick reference asset.
- Cheat sheets → System design: includes · System design quick reference asset.
- Cheat sheets → Python sheet: includes · Python quick reference asset.
- README → External resources: links out · Most learning content is sourced from outside the repository.
- Resource index → External resources: curates · The resource list acts as an index over third-party content.
- Link checker → README: validates · CI checks links in the canonical guide.
- Link checker → Translations: validates · Link checking also protects translated mirrors.
