github-starred/cs249r_book
2
0
Fork 0
mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-05-23 23:43:14 -05:00
Code Issues 114 Packages Projects Releases 24 Wiki Activity

[PR #1746] [MERGED] fix(mlsysim/docs): resolve 404s on Self-Paced Tutorial sidebar links #14645

New Issue
Closed
opened 2026-05-17 18:26:02 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-05-17 18:26:02 -05:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/harvard-edge/cs249r_book/pull/1746
Author: @farhan523
Created: 5/16/2026
Status: ✅ Merged
Merged: 5/16/2026
Merged by: @profvjreddi

Base: dev ← Head: fix/mlsysim-self-paced-tutorial-links

📝 Commits (1)

  • 972a8b6 fix(mlsysim/docs): resolve 404s on Self-Paced Tutorial sidebar links

📊 Changes

4 files changed (+927 additions, -3 deletions)

View changed files

📝 mlsysim/docs/config/_quarto-html.yml (+3 -3)
📝 mlsysim/docs/laws-explained.qmd (+0 -0)
➕ mlsysim/docs/tutorial/cheatsheet.qmd (+231 -0)
➕ mlsysim/docs/tutorial/exercises.qmd (+693 -0)

📄 Description

Summary

  • The three Self-Paced Tutorial sidebar links in mlsysim/docs/ 404 on both local preview and the dev deploy (e.g. …/tutorial/exercises.md).
  • Two of them pointed outside the Quarto project root (../tutorial/*.md), so Quarto never rendered or served them; the third linked to laws-explained.md rather than a rendered .html.
  • Brought all three pages under docs/ as .qmd so Quarto compiles them as normal site pages, and updated the sidebar hrefs in config/_quarto-html.yml (the canonical config; _quarto.yml is a symlink to it).

Changes

  • Copy mlsysim/tutorial/exercises.md → mlsysim/docs/tutorial/exercises.qmd
  • Copy mlsysim/tutorial/cheatsheet.md → mlsysim/docs/tutorial/cheatsheet.qmd
  • Rename mlsysim/docs/laws-explained.md → mlsysim/docs/laws-explained.qmd
  • Update sidebar hrefs in mlsysim/docs/config/_quarto-html.yml

The originals at mlsysim/tutorial/{exercises,cheatsheet}.md are kept as-is because tutorial/instructor-quickstart.md and tutorial/prerequisites.md still reference them. If a single source of truth is preferred, happy to swap to git mv and update those two references in a follow-up.

Test plan

  • quarto preview mlsysim/docs renders tutorial/exercises.qmd, tutorial/cheatsheet.qmd, and laws-explained.qmd without errors
  • Sidebar links resolve to /tutorial/exercises.html, /tutorial/cheatsheet.html, /laws-explained.html locally
  • Confirm same paths resolve on the dev deploy (harvard-edge.github.io/cs249r_book_dev/) after merge

🔄 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/1746 **Author:** [@farhan523](https://github.com/farhan523) **Created:** 5/16/2026 **Status:** ✅ Merged **Merged:** 5/16/2026 **Merged by:** [@profvjreddi](https://github.com/profvjreddi) **Base:** `dev` ← **Head:** `fix/mlsysim-self-paced-tutorial-links` --- ### 📝 Commits (1) - [`972a8b6`](https://github.com/harvard-edge/cs249r_book/commit/972a8b66d7481f5e5209b3a7b04a6690450b7339) fix(mlsysim/docs): resolve 404s on Self-Paced Tutorial sidebar links ### 📊 Changes **4 files changed** (+927 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `mlsysim/docs/config/_quarto-html.yml` (+3 -3) 📝 `mlsysim/docs/laws-explained.qmd` (+0 -0) ➕ `mlsysim/docs/tutorial/cheatsheet.qmd` (+231 -0) ➕ `mlsysim/docs/tutorial/exercises.qmd` (+693 -0) </details> ### 📄 Description ## Summary - The three **Self-Paced Tutorial** sidebar links in `mlsysim/docs/` 404 on both local preview and the dev deploy (e.g. `…/tutorial/exercises.md`). - Two of them pointed *outside* the Quarto project root (`../tutorial/*.md`), so Quarto never rendered or served them; the third linked to `laws-explained.md` rather than a rendered `.html`. - Brought all three pages under `docs/` as `.qmd` so Quarto compiles them as normal site pages, and updated the sidebar hrefs in `config/_quarto-html.yml` (the canonical config; `_quarto.yml` is a symlink to it). ## Changes - Copy `mlsysim/tutorial/exercises.md` → `mlsysim/docs/tutorial/exercises.qmd` - Copy `mlsysim/tutorial/cheatsheet.md` → `mlsysim/docs/tutorial/cheatsheet.qmd` - Rename `mlsysim/docs/laws-explained.md` → `mlsysim/docs/laws-explained.qmd` - Update sidebar hrefs in `mlsysim/docs/config/_quarto-html.yml` The originals at `mlsysim/tutorial/{exercises,cheatsheet}.md` are kept as-is because `tutorial/instructor-quickstart.md` and `tutorial/prerequisites.md` still reference them. If a single source of truth is preferred, happy to swap to `git mv` and update those two references in a follow-up. ## Test plan - [x] `quarto preview mlsysim/docs` renders `tutorial/exercises.qmd`, `tutorial/cheatsheet.qmd`, and `laws-explained.qmd` without errors - [x] Sidebar links resolve to `/tutorial/exercises.html`, `/tutorial/cheatsheet.html`, `/laws-explained.html` locally - [ ] Confirm same paths resolve on the dev deploy (`harvard-edge.github.io/cs249r_book_dev/`) after merge --- <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-17 18:26:02 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area: book
area: collabs
area: kits
area: labs
area: socratiq
area: tinytorch
area: tools
area: website
bug
dependencies
format: epub
format: pdf
javascript
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#14645
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?