How erencice/ai-data-science-roadmap works
Project type and purpose
• This repository is not an application or library in the traditional sense but a structured documentation guide—an “AI & Data Science Roadmap” composed entirely of Markdown content (only README.md plus LICENSE).
• Its purpose is to present a learning path, organized into numbered sections with links to courses, books, and resources.
File structure
• Top level contains:
• LICENSE
• README.md
• No code, no build scripts, no “src” or “docs” folder—so the core artifact is the single README.
README for additional insights
• The README is organized into 13 thematic sections (Mathematics, Statistics, Econometrics, …, LLMs).
• No mention of a custom toolchain; this lives purely as Markdown on GitHub.
• No CI/CD, no backend, no external APIs beyond hyperlinks to external learning sites.
a. Main components
• Content Source: Markdown files (README.md, future .md modules).
• Version Control: Git repository on a platform (GitHub).
• Build Pipeline (optional): Static-site generator (e.g., Jekyll, Hugo, Docusaurus) or GitHub Pages.
• Hosting/Delivery: GitHub Pages (or any static hosting/CDN).
• End User: Web browser or GitHub web UI.
• External Resources: External sites (Coursera, YouTube, PDF links).
b. Relationships and interactions
1. Author writes/updates Markdown in local Git clone.
2. Changes pushed to GitHub.
3. (Optional) CI/CD triggers SSG build, converts Markdown → HTML/CSS/JS.
4. Build artifacts deployed to hosting (GitHub Pages or CDN).
5. End user visits the published site; browser fetches static assets.
6. User clicks hyperlinks and navigates to external learning platforms.
c. Architectural patterns/design principles
• Separation of Concerns: Content authoring (Markdown) separate from presentation (SSG templates).
• Immutable Artifacts: Each build produces a fixed set of static files.
• CDN Delivery: Fast, globally distributed content delivery.
• Versioning & Collaboration: Git history + pull-request workflow.
d. Relevant technologies/frameworks/libraries
• Markdown, Git/GitHub, optional SSG (e.g., Jekyll), GitHub Actions (for CI/CD), GitHub Pages or Netlify for hosting.
• External services: Coursera, YouTube, Kaggle, Hugging Face, etc., as links.
Elements
• Clear labels: e.g., “Author,” “GitHub Repo,” “SSG Build,” “Static Hosting,” “User Browser.”
• From Author → GitHub Push
• GitHub → CI/CD → SSG Build
• SSG Build → Deploy → Hosting
• Hosting → User Browser
• Browser → External Resources
• Blue rectangles for internal components (Repo, Build Server).