Skip to content

site: depend on shared ecosystem chrome + finder table - #3

Open
seabbs-bot wants to merge 4 commits into
mainfrom
tutorials-redesign
Open

site: depend on shared ecosystem chrome + finder table#3
seabbs-bot wants to merge 4 commits into
mainfrom
tutorials-redesign

Conversation

@seabbs-bot

@seabbs-bot seabbs-bot commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Makes the tutorials site depend on the shared ecosystem chrome instead of carrying its own copy.

Supersedes the approach merged in #2, which inlined a duplicate navbar and footer.

What changed

  • _quarto.yml — no config-driven navbar or footer. The shared navbar.html / footer.html partials from the main site repo are injected via format.html.include-before-body / include-after-body, pulled in through a git submodule (_shared/siteEpiAware/epiaware.github.io).
  • search: true — the shared navbar carries a <div id="quarto-search">, but Quarto only emits search.json and site_libs/quarto-search/* when this flag is set, so with search: false the box rendered inert. Search is per-site: this indexes the tutorials content only.
  • tutorials/index.qmd — filterable finder table (search + approach filter) with a Package column linking to each package's docs. The filter widget JS is shared from the submodule. All 26 links verified to return 200.
  • .github/workflows/publish.yml — checkout inits submodules.

Merge order (important): the submodule pins an epiaware.github.io commit that currently lives on its shared-chrome branch (epiaware.github.io#26). That PR must merge first. Repoint the pin to the resulting main commit before merging this PR — if #26 is squash-merged and the branch deleted, the current pin becomes unreachable and CI will fail on submodule fetch.

Verified with a real quarto render: one navbar and one footer per page, search assets and index emitted, all 21 table rows rendering, logo resolving at depth.

This was opened by a bot. Please ping @seabbs for any questions.

Replace the tutorials site's own navbar and footer with the shared
navbar/footer HTML partials from the main epiaware.github.io site, pulled
in as a git submodule (_shared/site). The single source of truth now lives
in the main repo; the tutorials site renders it via include-before/after-body
instead of duplicating it. Keep the shared filter-table widget, and port the
package-tutorials finder table (search + approach filter + Package column
linking to each package's docs). CI inits submodules on checkout.
Point _shared/site at the main-site commit whose shared navbar.html renames
Docs to Packages and orders it before Tutorials, so the tutorials chrome
matches the ecosystem nav.
Seven links in the hand-authored tutorials table 404d: six
ComposableTuringIDModels case studies moved from /case-studies/ to
/tutorials/ on the live docs site, and the ConvolvedDistributions
"visualising convolutions" tutorial is actually published as
"convolving-distributions". Also make the CensoredDistributions
package-column links use /stable/ to match the tutorial links in the
same rows, and remove the leftover listing: block from the front
matter now that tutorials/ only contains the excluded index.qmd.
The shared navbar partial supplies a <div id="quarto-search"> that
quarto-search.js hydrates by id, but Quarto only emits search.json and
the site_libs/quarto-search/* assets when website.search is truthy. With
search: false the box rendered inert, a regression against the config
navbar this design replaced. Bump the submodule pin so the site picks up
the navbar revision that carries the search markup.
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.

1 participant