mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-07-17 08:28:07 -05:00

Files

Vijay Janapa Reddi 2190968942 refactor: deduplicate subscribe-modal + socratiQ via mirror sync script

Quarto's resource-copy step preserves symlinks rather than dereferencing
them, which breaks both local builds (AlreadyExists on the second pass)
and gh-pages deploys (relative symlink targets fall outside _build/).
And Sass resolves @import relative to the importing file's physical
location, not the symlink target. So symlinks inside the resource path
are not a viable dedup mechanism.

Instead, keep real file copies in each consumer subsite and enforce
dedup at edit time with shared/scripts/sync-mirrors.sh:

  - bash shared/scripts/sync-mirrors.sh           # propagate canonicals
  - bash shared/scripts/sync-mirrors.sh --check   # CI: fail on drift

Mirror map (source | mirrors):
  shared/scripts/subscribe-modal.js -> {site, book/quarto, labs, kits,
                                        mlsysim/docs}/.../subscribe-modal.js

Intentional non-mirrors (left untouched, customized variants):
  tinytorch/site-quarto/assets/scripts/subscribe-modal.js  (TinyTorch-branded)
  tinytorch/site/_static/subscribe-modal.js                (legacy Sphinx)

Also dedupe the SocratiQ widget bundle via a symlink (safe here because
book/tools/ sits outside any Quarto project, so the resource walker
never touches it):

  book/tools/scripts/socratiQ/bundle.js -> ../../../quarto/tools/scripts/socratiQ/bundle.js

The shared canonical (book/quarto/tools/scripts/socratiQ/bundle.js) is
the version actually referenced and served in production.

2026-04-19 10:31:41 -04:00

bundle.js

refactor: deduplicate subscribe-modal + socratiQ via mirror sync script

2026-04-19 10:31:41 -04:00

README.md

refactor: deduplicate subscribe-modal + socratiQ via mirror sync script

2026-04-19 10:31:41 -04:00

README.md

SocratiQ bundle (mirror)

This directory contains a single file, bundle.js, which is a symlink to the canonical bundle that is actually served from the rendered book site:

bundle.js -> ../../../quarto/tools/scripts/socratiQ/bundle.js

The served path on the deployed book is /tools/scripts/socratiQ/bundle.js, which is included from book/quarto/config/_quarto-html-vol1.yml and _quarto-html-vol2.yml.

When a new SocratiQ widget bundle is published, replace book/quarto/tools/scripts/socratiQ/bundle.js. This mirror updates automatically via the symlink.

The SocratiQ widget itself is documented in book/socratiQ/README.md.