How nishant-tiwari24/roadmap works
Project type and purpose
• This repository is a collection of markdown-based roadmaps, not an application or service in the traditional sense. It’s essentially a content repository meant to help learners navigate various domains (AI/ML, coding, cybersecurity).
• There is no backend code, database, or frontend application here—just static .md files.
File structure
• Top-level files:
• AIML-Roadmap.md
• Coding-For-Beginners.md
• Cybersecurity.md
• README.md
• No subdirectories, no code files, no configuration or build scripts. This indicates that the repo is designed purely for content versioning and consumption.
Extract insights from the README
• Purpose: “A collection of all the roadmaps to help you navigate and upskill different domains effectively.”
a. Main components
• Content Repository (GitHub)
• Continuous Integration (optional): e.g., GitHub Actions
• Static Site Generator (optional): e.g., MkDocs, Jekyll
• Hosting/CDN (optional): e.g., GitHub Pages, Netlify, Vercel
• End User (Web Browser)
b. Relationships & interactions
1. Authors push changes (roadmap .md files) to the GitHub repo.
2. CI/CD pipeline (if configured) picks up changes and runs the static site generator to produce HTML/CSS.
3. Generated site is deployed to a hosting platform or CDN.
4. End users request the site; the CDN or host returns the rendered pages.
c. Architectural patterns & principles
• Content-as-Code pattern: treating markdown content in a version-controlled repo.
• CI/CD for documentation: automating build and deploy of a static site whenever content is updated.
• Static-first architecture: no dynamic server, everything pre-rendered.
d. Key technologies (optional, based on your choice)
• GitHub (repo + pages)
• GitHub Actions (CI)
• MkDocs or Jekyll (SSG)
• Netlify/Vercel/CDN (hosting)