Skip to content

docs: clear, grouped prerequisites in the handbook and both READMEs - #57

Merged
project-delphi merged 1 commit into
mainfrom
feat/issue-51-prerequisites
Sep 3, 2026
Merged

docs: clear, grouped prerequisites in the handbook and both READMEs#57
project-delphi merged 1 commit into
mainfrom
feat/issue-51-prerequisites

Conversation

@project-delphi

Copy link
Copy Markdown
Owner

Closes #51.

What changed

The prerequisites were a single flat list that mixed do this beforehand with have this on the day, and left the required pre-work as the last bullet. They are now three labelled groups, every item linked:

  • Do before the session — the book chapter, linear-algebra-deep-learning (still marked required), and running notebook 00 in Colab.
  • Recommended — 3Blue1Brown's Essence of linear algebra, 16 videos, ~3 h. New workshop.prereq_video_url in _variables.yml, so both landing pages read it from the one source.
  • Have ready on the day — a Google account (→ Colab), Discord, and a phone or second tab for Kahoot.

Four surfaces carry the same list: index.qmd, es/index.qmd, both halves of README.md, and the handbook (which hard-codes its links, as it already did, and speaks in Blocks rather than section numbers).

Discord is deliberately prose-only — "the invite comes from the facilitator". There is no public invite in the repo, and a placeholder URL is worse than none.

On the diff size

Two things beyond the prose:

  1. docs/notebooks/ had gone stale against notebooks/ again — all twelve. Re-rendering syncs them, which is most of the line count. This is exactly the failure CLAUDE.md documents under Publishing: the regenerate gate never looks in docs/, and compare_render.py walks only *.html, so nothing catches it.
  2. The Bootstrap and syntax-highlighting CSS get new content-hashed names — the macOS/ubuntu SCSS difference the same section describes. compare_render.py normalizes hashed asset names, so the publish gate is unaffected.

Verified

  • gen_tables.py and gen_notebooks.py rerun with no tree drift.
  • quarto render with the pinned 1.6.40.
  • check_links.py: all eight failable checks pass (688 internal links, both landing pages, the 195-minute clock). Check 9 still prints the pre-existing Kahoot TODO, which is not a failure.

🤖 Generated with Claude Code

https://claude.ai/code/session_0125vs3ARnz2pLp8D5vQ6iKJ

@project-delphi
project-delphi force-pushed the feat/issue-51-prerequisites branch from 1c7a4b0 to 5ba92c9 Compare September 3, 2026 17:41
)

The prerequisites were one flat list that mixed what you must do beforehand
with what you need on the day, and buried the required pre-work in the last
bullet. Group them instead — do before the session / recommended / have ready
on the day — and give every item its link: the book chapter, the pre-work
repo, notebook 00 in Colab, a Google account, Discord, Kahoot.

Adds 3Blue1Brown's "Essence of linear algebra" (16 videos, ~3 h) as a
recommended prerequisite, in _variables.yml as workshop.prereq_video_url so
both landing pages read it from the one source. Discord stays prose-only: the
invite comes from the facilitator and there is no public link to point at.

The same four surfaces carry it: index.qmd, es/index.qmd, both halves of
README.md and the handbook, which hard-codes its links as it already does and
speaks in Blocks rather than section numbers.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0125vs3ARnz2pLp8D5vQ6iKJ
@project-delphi
project-delphi force-pushed the feat/issue-51-prerequisites branch from 5ba92c9 to ec99c1f Compare September 3, 2026 17:43
@project-delphi
project-delphi merged commit 0a56e15 into main Sep 3, 2026
1 check passed
@project-delphi
project-delphi deleted the feat/issue-51-prerequisites branch September 3, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clean pre-requistes in handbook and README

1 participant