- Add wrap_readme_data_tables.py to frame <table>+<thead>/<tbody> blocks in a 98% width panel (#cfd6dd border, #eef2f7 headers, zebra body rows where applied manually in converted tables). - Apply wraps to book, kits, labs, slides, tinytorch; tbody wraps for kits docs/related and instructors overview. - Convert remaining Markdown tables in mlsysim, mlperf-edu, and interviews to the same HTML pattern; replace StaffML markdown callouts with HTML panels. - Add thead rows to kits/instructors body-only tables for clearer hierarchy.
🗺️ The Blueprint — Instructor Site
|
📖 What This Is
"The Blueprint" is the instructor-facing companion site for the ML Systems textbook. It provides everything needed to teach AI Engineering as a university course.
|
🛠️ Building Locally
cd instructors/ quarto preview
Requires Quarto 1.4+.
📂 File Structure
instructors/
├── _quarto.yml # Site configuration
├── index.qmd # Landing page (hero + overview)
├── getting-started.qmd # 8-step adoption checklist
├── course-map.qmd # Integration matrix + SVG diagrams
├── foundations-syllabus.qmd # Semester 1: 16-week schedule
├── scale-syllabus.qmd # Semester 2: 16-week schedule
├── pedagogy.qmd # Learning science + facilitation
├── assessment.qmd # Rubrics + sample work
├── ta-guide.qmd # TA training + grading workflows
├── customization.qmd # Quarter/seminar/emphasis variants
├── faq.qmd # Common instructor questions
└── assets/ # Styles and SVGs
🎨 Style Conventions
This site follows the MLSysBook ecosystem design system:
- Accent color: Indigo (
#6366f1light,#818cf8dark) - Callout geometry: 5px left border, 0.5rem radius, 8% opacity backgrounds
- Typography: Inter (body), Outfit (headings), JetBrains Mono (code)
- Navbar: Dark background (
#0a0a0f), matching book sites
See assets/styles/style.scss for full details.
Contributors
Thanks to these wonderful people who have helped build the Instructor Site!
Legend: 🪲 Bug Hunter · ⚡ Code Warrior · 📚 Documentation Hero · 🎨 Design Artist · 🧠 Idea Generator · 🔎 Code Reviewer · 🧪 Test Engineer · 🛠️ Tool Builder
Vijay Janapa Reddi 🧑💻 🎨 ✍️ |
Recognize a contributor: Comment on any issue or PR:
@all-contributors please add @username for code, design, doc in instructors