$ show nilbuild/developer-roadmap
This repository is the content engine for roadmap.sh, a popular educational platform that provides structured learning paths for software engineering, data science, and other technical domains. The codebase is primarily a content management system implemented as a monorepo containing thousands of markdown files organized by roadmap (e.g., backend, frontend, devops, AI engineering) along with TypeScript scripts that orchestrate bidirectional synchronization between these markdown files and the roadmap.sh API/database. The actual application logic is minimal: the scripts parse markdown into structured data models, push content to a REST API, pull API data back into markdown, and clean up orphaned content. The vast majority of the repository is static educational content rather than application code, making it a hybrid of a content repository and a lightweight CMS backend. The architecture is tightly coupled to the roadmap.sh platform's specific data model and API endpoints, limiting general reusability but demonstrating a clean pattern for docs-as-code workflows.
The LLM identified 2 files worth highlighting for reuse:
Implements a diff-and-cleanup algorithm that compares the current state of roadmap nodes from the API against the filesystem, then renames or deletes stale markdown files. This pattern is reusable for any project that needs to maintain consistency between a Git-based content store and an external database, handling the common problem of content drift with a deterministic cleanup strategy.
Provides a thin wrapper around markdown content with dynamic variable substitution (e.g., @currentYear@). While simple, it encapsulates a pattern for injecting contextual data into static markdown during the build/sync phase, which is reusable across static site generators or documentation pipelines that need to keep markdown evergreen without modifying source files.