mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-05-06 17:49:07 -05:00
825d9571a6
- Remove retired _archive/ and scripts/archive/ trees (site, book filters, games, vault); vault CHANGELOG points to git history for old scripts. - CONTRIBUTING: site project row, site/ in area map, root vs TinyTorch pre-commit, vault schema drift wording. - Newsletter CLI: path-agnostic news alias; tinytorch pre-commit comments; add tools/ and staffml-vault-types READMEs for maintainers.
17 lines
1.1 KiB
Markdown
17 lines
1.1 KiB
Markdown
# Repository-level tooling (`tools/`)
|
|
|
|
Scripts and audit artifacts at the **monorepo root** (not `book/tools/`, which is textbook-specific).
|
|
|
|
## Layout
|
|
|
|
| Path | Role |
|
|
|------|------|
|
|
| [`audit/`](audit/) | Math/HTML/PDF audit scripts for the Quarto book (see `audit/README.md`). |
|
|
| [`release-smoke/`](release-smoke/) | Playwright smoke checks for published sites; see `release-smoke/package.json`. Generated reports live under `release-smoke/reports/` (timestamped JSON). Safe to delete old reports when pruning; regenerate by re-running smoke. |
|
|
| `phase_b/` … `phase_g/`, `lint_calibration/` | One-off **cleanup and lint calibration manifests** from past passes (JSON/Markdown). Kept for traceability; not imported by CI or application code. Remove or archive only when maintainers agree the history is no longer needed. |
|
|
| `validate_playbook.py` | Standalone validation helper; see file docstring for usage. |
|
|
|
|
## Relationship to `book/tools/`
|
|
|
|
Use `book/tools/` for BibTeX, git hooks wiring, quarto scripts, and book prose validators. Use **`tools/` here** for cross-cutting audits, release smoke tests, and historical phase outputs.
|