About¶
What this is¶
A static site aggregating the curricula authored in self_dev/ - nine 24-week master-level programs in systems engineering and AI infrastructure. The site is presentation; the Markdown in each *_PLAN/ directory is the source of truth.
Build¶
cd learning_path
make install # creates .venv, installs MkDocs Material + plugins
make serve # builds and serves at http://127.0.0.1:8000
make site # static build under ./site/ (also runs --strict link check)
make deploy # push to gh-pages (configure repo first)
make clean # remove ./build and ./site
Stack¶
- MkDocs (static site generator).
- Material for MkDocs (theme - nav, search, dark mode, syntax highlighting).
awesome-pagesplugin (auto-generates nav from directory structure + per-section.pagesfiles).tagsplugin (cross-cutting topic indexes - v0.2).pymdownxextensions (admonitions, tabs, code annotations, mermaid).
How content flows¶
self_dev/<X>_PLAN/*.md ──┐
├── scripts/build.py ──► build/docs/paths/<x>/*.md
learning_path/docs/**.md ──┘ │
▼
mkdocs build
│
▼
./site/
The source curricula are never mutated. build.py copies them into build/docs/, renames files to URL-friendly slugs (lowercase + dashes), turns each path's README.md into index.md, and writes a .pages file per directory for nav titles and order.
Adding a path¶
- Drop a new directory under
self_dev/following the established shape (README.md,00_PRELUDE_*.md,01_MONTH_*.md, …). - Add one entry to the
PATHSlist inscripts/build.py: make serve- the new path appears.
License¶
Content is the author's; site code is MIT.