Adds docstrings to the 900 definitions and 8 modules that had none across the binder CLI, its checks, and the audit and maintenance tools, and corrects a few docstrings that no longer matched the code. Only documentation changed.
The design grammar catalog is no longer maintained. Remove design-grammar/
and everything that consumed it:
- StaffML: the /framework route, its CSS module and pop-in keyframes, the
generated designGrammar.ts, the sync script and its predev/prebuild
hooks, the modal a11y test, and the Framework entries in the nav, the
ecosystem bar, and the screenshot/responsive audit route lists.
- CI: design-grammar leaves the staffml-validate-dev sparse checkouts; the
comment that explained why it was needed goes with it.
- The contributors config, its README section, the root README project
bullet, the citation-packet scopes, the bib style baseline entries, the
periodic-table ignore rule, and the repository map.
TinyTorch, MLSys·im, MLPerf EDU, the slides, and the instructor site return
from packages/ and materials/ to the top level, so each folder carries the
name of its site URL (tinytorch/ is mlsysbook.ai/tinytorch/). main still has
this layout, so the GitHub links on the published pages, existing tito
installs, and the release hashes keep working.
References follow: workflows, the binder toolchain, book configs, tests,
docs, contributor tooling, .gitignore, and pre-commit patterns. Relative
paths inside the moved projects drop the extra ../ they gained under
packages/ and materials/, which also repairs the MLSys·im contributing guide
and tutorial decks that pointed at the removed slides symlink. The TinyTorch
installer and updater return to a single sparse path. REPO_LAYOUT.md and
CI-VARIABLES.md describe the result.
The top-level mlsysim, tinytorch, mlperf-edu, slides, and instructors
entries were symlinks into packages/ and materials/. Every reference now
names the real path, and the symlinks are removed.
- Workflows: path filters, working directories, artifact and publish
paths, and the TINYTORCH_SITE, MLSYSIM_DOCS, SLIDES_ROOT, and
INSTRUCTORS_ROOT variables, which now carry fallbacks. The gh-pages
deploy trees and the site URLs keep their top-level names.
- Book builds: PYTHONPATH in the PDF configs and execute-env.yml points
at packages/mlsysim. The execute-env.yml value was still written for
the old publishing/quarto project root.
- The binder toolchain, labs, and tests load mlsysim from
packages/mlsysim, and the root pytest config puts it on sys.path. That
clears the binder test failures caused by importing the symlink as a
namespace package (now 362 passed).
- The TinyTorch installer and `tito system update` fetch packages/tinytorch
and fall back to tinytorch/ for tags that predate the move. Binder launch
links and postBuild open packages/tinytorch.
- READMEs, CONTRIBUTING, SECURITY, contributor tooling, area labels,
.gitignore, and pre-commit patterns name the real paths.
A repository variable that still holds an old top-level path overrides
the new fallback and breaks its workflow, so those variables need
updating before these workflows run.
The toolchain folder is now binder/, and the root ./binder symlink is gone.
The command is ./binder/binder: a plain path to the script, with no link and
no install step. Every invocation moved with it: pre-commit entries, workflow
steps, the VS Code extension's command palette, help text, and docs.
- bindery/ paths and bindery.* imports, including the chapter code cells
that import binder.tools.figures, now name binder/.
- Binder (mybinder.org) reads its configuration from a root binder/ folder
and refuses to build when binder/ and .binder/ both exist. .binder/postBuild
and .binder/requirements.txt move into binder/, so the TinyTorch "Launch
Binder" buttons keep working; binder/README.md records which file names the
toolchain must not use there.
- contributors/projects.json still pointed the book's contributor record at
publishing/; it now names binder/, where that .all-contributorsrc lives.
- The margin-figure reader-link audit report linked its 222 figures through
the retired quarto/ tree; the links now resolve under books/.
The hooks reformatted hidden Python cells and trimmed whitespace in the
Volume II chapters whose figure imports this rename touches.
Checks: ./binder/binder check cli passes (contract and canonical hooks),
binder.tools.figures imports, and every workflow YAML file parses.
binder test suite, excluding the four modules that cannot import mlsysim
through the root symlink (fixed separately): 7 failed, 346 passed.
The GitHub repository variables BOOK_ROOT, BOOK_TOOLS, BOOK_DEPS, and
BOOK_DOCKER still name the retired book/ layout and must change when this
reaches origin.