How sujalrajapure/ai_ml_data-science_roadmap works
Project type and purpose
• This “project” is not a multi‐module codebase but a single Markdown-based roadmap document (README.md) meant to guide learners through a 180-day Machine Learning career plan.
• It serves as static content rather than a running application or library.
File structure
• Top-level contains only README.md.
• No source code, no frontend/backend folders, no configuration or infrastructure definitions.
README for additional insights
• It lays out 6 phases of daily topics, tools, resources, and tips.
• References external services: GitHub, Kaggle, Colab, Coursera, Heroku, etc.
• No internal modules or microservices—sole focus is on content delivery.
a. Content Authoring
• Component: Markdown Editor (e.g., VS Code)
• Output: README.md stored in Git repository
b. Version Control & CI/CD
• Component: GitHub Repository
• Actions: On push → run link-checker / spell-checker → optional site build
c. Static Site Generator (optional)
• Component: MkDocs, Docusaurus or Jekyll
• Responsibility: Transform README and any additional docs into HTML/CSS/JS
d. Hosting & CDN
• Component: GitHub Pages, Netlify or similar
• Delivers: Static assets to end-users
e. End-User Access
• Component: Web Browser
• Interacts: Fetches static site, renders roadmap tables, links
You may also include external integrations:
• Analytics Service (Google Analytics) for page views
• Search Service (Algolia DocSearch) for keyword lookup
Architectural patterns or design principles
• Content-as-Code: Markdown managed in Git
• CI/CD Pipeline: Automated validation & deployment
• Separation of Concerns:
• Authoring (Markdown) vs. Rendering (Static site) vs. Delivery (CDN)