Files
Vijay Janapa Reddi 216b02a1cd Mark Volumes III and IV as in development and add folder READMEs
The top-level README and the Volume III and IV READMEs now say the volumes are in development and change quickly. New READMEs explain what books/, books/config/, docs/, and shared/ contain.
2026-09-12 11:55:04 +02:00

1.1 KiB

Shared

Assets and tooling used by more than one site in the repository (the books, TinyTorch, MLSys·im, labs, kits, slides, instructors, StaffML, and the landing site). Anything used by only one project belongs in that project's folder instead.

Folder Contents
styles/ Brand tokens, shared SCSS partials, and per-project accent themes (see its README)
config/ Common navbar and footer, <head> includes, ecosystem cards, redirect maps, and link-checker ignore lists
release/ The release pill and release card shown across sites (see its README)
scripts/ Cross-site build helpers: redirects, sitemap, internal link checks, build stamps, stats injection, and shared browser scripts
assets/ Images shared by several sites

Some shared files are mirrored into individual projects so each site can build on its own. After editing scripts/subscribe-modal.js or another mirrored file, run bash shared/scripts/sync-mirrors.sh; the pre-commit check fails if the copies drift.