# khanhnamle1994/cracking-the-data-science-interview architecture

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

- Interactive diagram: https://gitdiagram.com/khanhnamle1994/cracking-the-data-science-interview
- Repository: https://github.com/khanhnamle1994/cracking-the-data-science-interview

## Overview

##### Main Components
- Repo Host (GitHub): the origin of truth for code and content.
- Landing Page (README.md): entry point that links to all major content categories.
- Content Modules (top-level directories):
- Cheatsheets
- EBooks
- Question-Bank
- Case-Studies
- (Portfolios are external links but can be shown as “External Services”)
- Build/Publish Tools (only relevant for the Python Data Science Handbook website submodule).
- Consumers:
- Humans browsing on GitHub
- (Optional) Static site generator or docs builder

##### Relationships & Data Flows
- The README “routes” users to each content module.
- Each content module holds subfolders (e.g., in EBooks: individual books, with Jupyter notebooks, PDFs, R scripts, images).
- The Python-Data-Science-Handbook module further contains a “website” folder with Pelican (fabfile.py, pelicanconf.py, theme templates) for static site generation.
- Users clone or fork the repo → open README → navigate to modules → view Markdown/PDF/notebook files → optionally run notebooks locally.

##### Architectural Patterns / Principles
- Separation of Concerns: each top-level directory is self-contained.
- Content-Driven Structure: directory names map 1:1 to navigation labels in README.
- Extensibility: new modules can be added without disrupting existing ones.
- Submodule Pattern: the Python Data Science Handbook “website” subfolder is effectively its own mini static-site project.

##### Technologies
- Git / GitHub (version control, hosting)
- Markdown (documentation)
- Jupyter Notebooks (interactive content)
- PDF/Images (static assets)
- Pelican (static site generator for the Handbook website)
- Python/R (scripts in EBooks)

##### Keep It Detailed but Focused
- Every top-level directory as a component.
- Critical files (e.g., fabfile.py, pelicanconf.py) in the build sub-module.
- Do not overload with every notebook—represent notebooks generically.
- Navigation flow (README → module → content) is crystal clear.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Core Repository
    GitHubRepo["GitHub Repository"]:::repo
    README["README.md"]:::content

    GitHubRepo -->|hosts| README

    %% Content Modules
    Cheatsheets["Cheatsheets"]:::module
    EBooks["EBooks"]:::module
    QuestionBank["Question-Bank"]:::module
    CaseStudies["Case-Studies"]:::module
    Handbook["Python Data Science Handbook"]:::module

    README -->|links to| Cheatsheets
    README -->|links to| EBooks
    README -->|links to| QuestionBank
    README -->|links to| CaseStudies
    README -->|links to| Handbook
    README -->|external links| ExternalSites

    %% Handbook Submodule Structure
    subgraph "Handbook Submodule"
        notebooks["notebooks"]:::content
        website["website (Pelican)"]:::build
        tools["tools"]:::build
    end

    Handbook --> notebooks
    Handbook --> website
    Handbook --> tools

    %% Website Build Pipeline
    fabfile["fabfile.py"]:::build
    pelicanconf["pelicanconf.py"]:::build
    publishconf["publishconf.py"]:::build
    theme["theme (templates & assets)"]:::build
    Pelican["Pelican"]:::tool

    website -->|contains| fabfile
    website -->|contains| pelicanconf
    website -->|contains| publishconf
    website -->|contains| theme
    fabfile -->|runs| Pelican
    website -->|uses| Pelican

    %% Users and External
    User["User"]:::user
    ExternalSites["External Sites"]:::external

    User -->|clones\/pulls| GitHubRepo
    User -->|views| README

    %% Click Events
    click README "https://github.com/khanhnamle1994/cracking-the-data-science-interview/blob/master/README.md"
    click Cheatsheets "https://github.com/khanhnamle1994/cracking-the-data-science-interview/tree/master/Cheatsheets/"
    click CaseStudies "https://github.com/khanhnamle1994/cracking-the-data-science-interview/tree/master/Case-Studies/"
    click QuestionBank "https://github.com/khanhnamle1994/cracking-the-data-science-interview/tree/master/Question-Bank/"
    click EBooks "https://github.com/khanhnamle1994/cracking-the-data-science-interview/tree/master/EBooks/"
    click Handbook "https://github.com/khanhnamle1994/cracking-the-data-science-interview/tree/master/EBooks/Python-Data-Science-Handbook/"
    click notebooks "https://github.com/khanhnamle1994/cracking-the-data-science-interview/tree/master/EBooks/Python-Data-Science-Handbook/notebooks/"
    click website "https://github.com/khanhnamle1994/cracking-the-data-science-interview/tree/master/EBooks/Python-Data-Science-Handbook/website/"
    click fabfile "https://github.com/khanhnamle1994/cracking-the-data-science-interview/blob/master/EBooks/Python-Data-Science-Handbook/website/fabfile.py"
    click pelicanconf "https://github.com/khanhnamle1994/cracking-the-data-science-interview/blob/master/EBooks/Python-Data-Science-Handbook/website/pelicanconf.py"
    click publishconf "https://github.com/khanhnamle1994/cracking-the-data-science-interview/blob/master/EBooks/Python-Data-Science-Handbook/website/publishconf.py"
    click theme "https://github.com/khanhnamle1994/cracking-the-data-science-interview/tree/master/EBooks/Python-Data-Science-Handbook/website/theme/"
    click tools "https://github.com/khanhnamle1994/cracking-the-data-science-interview/tree/master/EBooks/Python-Data-Science-Handbook/tools/"

    %% Styles
    classDef repo fill:#f9f,stroke:#333,stroke-width:1px;
    classDef content fill:#bbf,stroke:#333;
    classDef module fill:#9cf,stroke:#333;
    classDef build fill:#8f8,stroke:#333;
    classDef tool fill:#8ff,stroke:#333;
    classDef user fill:#ff9,stroke:#333;
    classDef external fill:#f89,stroke:#333,stroke-dasharray:5;
```
