How milanm/dotnet-developer-roadmap works
Project type & purpose
• This is a static documentation site (Markdown + images + PDFs) serving a “.NET Developer Roadmap” guide.
• Key artifacts: README.md (primary content), roadmap images (PNG), downloadable PDFs, and links to external resources (Patreon, newsletter).
• Users consume the content via a web browser (e.g., GitHub Pages or a similar static‐site host).
File structure
• Top level:
• README.md – main content
• NET Roadmap.pdf / NET Developer Roadmap Minimal.pdf – compiled guides
• Images (Bundle.png, roadmap PNGs) used inline in the docs
• LICENSE, .gitignore – metadata
• No runtime code, no frontend/backend folders, no compiled binaries—this is purely content.
README
• Confirms it is a learning resource with embedded images, downloadable PDFs, and external links.
• No mention of a dynamic server, database, or APIs.
Main components
a. Source Content Repository (GitHub)
• Markdown files
• Image assets
• PDF source files
b. Build Pipeline (CI/CD)
• Static‐Site Generator (e.g., Jekyll, Hugo, or GitHub Pages engine) or a Markdown→HTML tool
• PDF bundling process (if automated)
c. Hosting / CDN
• GitHub Pages or another static hosting (Azure Static Web Apps, Netlify)
• CDN layer for assets (optional)
d. End Users
• Web browsers requesting HTML, images, PDF downloads
e. External Services
• Patreon (for paid bundle purchases)
• Newsletter platform (subscription form)
• Analytics (optional, e.g., Google Analytics)
• GitHub (issue tracker, PRs)
Relationships & data flow
• Developer pushes updates → GitHub repo
• Push triggers CI/CD pipeline → runs SSG → generates HTML/CSS/JS + PDFs
• Artifacts deployed to Hosting/CDN
• End user browser → requests HTML, images, PDF downloads
• External links embedded in HTML connect users to Patreon/newsletter
• Optionally: Web analytics collect usage data
Architectural patterns & design principles
• Content‐as‐code: Versioned Markdown + assets in Git
• CI/CD pattern: Automated build & deploy on commit
• Static site delivery: Fast, globally cached, no server logic
• Single responsibility: README.md owns content; GitHub Actions owns build/deploy
Technologies & frameworks
• GitHub & GitHub Actions (or alternative CI/CD)
• Static‐Site Generator (Jekyll, Hugo, or native Markdown renderer)
• GitHub Pages / Azure Static Web Apps / Netlify
• Markdown, HTML, CSS
• PDF generation tool (Pandoc or custom scripts)
• CDN (optional, e.g., Cloudflare)