github-starred/cs249r_book
2
0
Fork 0
mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-05-07 10:08:50 -05:00
Code Issues 85 Packages Projects Releases 24 Wiki Activity

[PR #1505] [MERGED] docs(announcements): unify announcement bars across nine Quarto sites #9172

New Issue
Closed
opened 2026-05-03 01:24:44 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-05-03 01:24:44 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/harvard-edge/cs249r_book/pull/1505
Author: @profvjreddi
Created: 4/23/2026
Status: ✅ Merged
Merged: 4/23/2026
Merged by: @profvjreddi

Base: dev ← Head: docs/announcement-banners-unified

📝 Commits (1)

  • ad98437 docs(announcements): unify announcement bars across nine Quarto sites

📊 Changes

9 files changed (+116 additions, -40 deletions)

View changed files

📝 book/quarto/config/shared/html/announcement-vol1.yml (+10 -4)
📝 book/quarto/config/shared/html/announcement-vol2.yml (+9 -3)
📝 instructors/config/announcement.yml (+13 -5)
📝 kits/config/announcement.yml (+12 -5)
📝 labs/config/announcement.yml (+12 -5)
📝 mlsysim/docs/config/announcement.yml (+12 -4)
📝 site/config/announcement.yml (+14 -5)
📝 slides/config/announcement.yml (+13 -5)
📝 tinytorch/quarto/config/announcement.yml (+21 -4)

📄 Description

Summary

Replaces the drifted per-site announcement bars with one unifying template that makes the curriculum shape legible on every site.

Template (all nine Quarto sites):

Line Role
1 Identity + primary CTA (what is THIS site)
2 The book (or, on book sites, the other volume)
3 "Alongside the book:" sibling row (3 most-relevant verbs)
4 Newsletter

Line 3 is the spine — the same phrase appears on every site, with verb tags (build / deploy / simulate / explore / teach) that reveal each site's role in the curriculum at a glance. The book is unambiguously the anchor; everything else is a verb applied to it.

Files changed (9)

  • site/config/announcement.yml (landing — 5-line variant covering all verbs)
  • book/quarto/config/shared/html/announcement-vol1.yml
  • book/quarto/config/shared/html/announcement-vol2.yml
  • tinytorch/quarto/config/announcement.yml
  • kits/config/announcement.yml
  • labs/config/announcement.yml
  • mlsysim/docs/config/announcement.yml
  • slides/config/announcement.yml
  • instructors/config/announcement.yml

What got fixed along the way

  • Stale holiday copy removed from kits and labs ("Happy New Year!")
  • "Coming in 2026" on labs → "Coming Summer 2026" (we're in 2026)
  • TinyTorch v0.1.10 single-line release notice → full 4-line unified bar (release notices belong in changelog, not always-visible nav)
  • /book legacy links → /vol1/ and /vol2/ (the repo has been vol-split; /book is ambiguous)
  • Newsletter #subscribe → https://mlsysbook.ai/newsletter/ (the #subscribe anchor only resolves on the landing page)
  • Trailing-slash hygiene on all outbound URLs

Out of scope

StaffML is a Next.js app, not a Quarto site — so the YAML-driven announcement.yml mechanism doesn't apply. A matching React banner component will ship as a separate PR.

Test plan

  • All 9 YAML files parse cleanly (yaml.safe_load green)
  • All 9 bars have exactly 4 line-break-separated content lines (landing page has 4; no 5-line bars today — landing page 4 lines cover learner + teacher + newsletter rows)
  • All pre-commit hooks passed
  • Post-merge: preview deploys on all affected sites and eyeball the rendered bar

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/harvard-edge/cs249r_book/pull/1505 **Author:** [@profvjreddi](https://github.com/profvjreddi) **Created:** 4/23/2026 **Status:** ✅ Merged **Merged:** 4/23/2026 **Merged by:** [@profvjreddi](https://github.com/profvjreddi) **Base:** `dev` ← **Head:** `docs/announcement-banners-unified` --- ### 📝 Commits (1) - [`ad98437`](https://github.com/harvard-edge/cs249r_book/commit/ad98437b4c83c8f8aa5512a042cd9dab240eaaf8) docs(announcements): unify announcement bars across nine Quarto sites ### 📊 Changes **9 files changed** (+116 additions, -40 deletions) <details> <summary>View changed files</summary> 📝 `book/quarto/config/shared/html/announcement-vol1.yml` (+10 -4) 📝 `book/quarto/config/shared/html/announcement-vol2.yml` (+9 -3) 📝 `instructors/config/announcement.yml` (+13 -5) 📝 `kits/config/announcement.yml` (+12 -5) 📝 `labs/config/announcement.yml` (+12 -5) 📝 `mlsysim/docs/config/announcement.yml` (+12 -4) 📝 `site/config/announcement.yml` (+14 -5) 📝 `slides/config/announcement.yml` (+13 -5) 📝 `tinytorch/quarto/config/announcement.yml` (+21 -4) </details> ### 📄 Description ## Summary Replaces the drifted per-site announcement bars with one unifying template that makes the curriculum shape legible on every site. **Template (all nine Quarto sites):** | Line | Role | |---|---| | 1 | Identity + primary CTA (what is THIS site) | | 2 | The book (or, on book sites, the other volume) | | 3 | **"Alongside the book:"** sibling row (3 most-relevant verbs) | | 4 | Newsletter | Line 3 is the spine — the same phrase appears on every site, with verb tags (build / deploy / simulate / explore / teach) that reveal each site's role in the curriculum at a glance. The book is unambiguously the anchor; everything else is a verb applied to it. ## Files changed (9) - `site/config/announcement.yml` (landing — 5-line variant covering all verbs) - `book/quarto/config/shared/html/announcement-vol1.yml` - `book/quarto/config/shared/html/announcement-vol2.yml` - `tinytorch/quarto/config/announcement.yml` - `kits/config/announcement.yml` - `labs/config/announcement.yml` - `mlsysim/docs/config/announcement.yml` - `slides/config/announcement.yml` - `instructors/config/announcement.yml` ## What got fixed along the way - **Stale holiday copy** removed from `kits` and `labs` ("Happy New Year!") - **"Coming in 2026"** on labs → "Coming Summer 2026" (we're in 2026) - **TinyTorch v0.1.10** single-line release notice → full 4-line unified bar (release notices belong in changelog, not always-visible nav) - **`/book` legacy links** → `/vol1/` and `/vol2/` (the repo has been vol-split; `/book` is ambiguous) - **Newsletter `#subscribe`** → `https://mlsysbook.ai/newsletter/` (the `#subscribe` anchor only resolves on the landing page) - **Trailing-slash hygiene** on all outbound URLs ## Out of scope **StaffML** is a Next.js app, not a Quarto site — so the YAML-driven `announcement.yml` mechanism doesn't apply. A matching React banner component will ship as a separate PR. ## Test plan - [x] All 9 YAML files parse cleanly (`yaml.safe_load` green) - [x] All 9 bars have exactly 4 line-break-separated content lines (landing page has 4; no 5-line bars today — landing page 4 lines cover learner + teacher + newsletter rows) - [x] All pre-commit hooks passed - [ ] Post-merge: preview deploys on all affected sites and eyeball the rendered bar --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-05-03 01:24:44 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area: book
area: collabs
area: kits
area: socratiq
area: tinytorch
area: tools
area: website
bug
dependencies
format: epub
format: pdf
link-health
link-rot
priority-high
pull-request
Mirrored from GitHub Pull Request
 staffml
type: bug
type: citation
type: code
type: errata
type: improvement
type: new
type: question
vault-sli
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/cs249r_book#9172
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?