How khanhnamle1994/cracking-the-data-science-interview works
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.