ERDW_HowCurrentDocsAreBuilt - delph-in/docs GitHub Wiki

This page describes how the delph-in.github.io/docs/ documentation site is built as of August 2026. For the exhaustive reference on site structure and the sitesdefinitions.json format, see DelphinDocsReference.md and DocsQuickStart.md in the docs repository.

Overview

The public documentation site is a curated subset of pages pulled from this wiki (and a few other sources), built by GitHub Actions and published with GitHub Pages. Which wiki pages get included, and where they show up in the site's navigation, is controlled by sitesdefinitions.json in the docs repository.

When does a wiki edit show up on the docs site?

Three things can trigger a rebuild:

  • A wiki page is created, edited, or renamed (BuildDocsOnWikiEdit.yml): GitHub fires a gollum event for every wiki change, which kicks off a build within a few minutes. This is new as of August 2026 -- previously the site only rebuilt once a day.
  • A daily fallback check (DailyDocBuildIfWikiUpdates.yml, 06:45 UTC): mostly a safety net in case a gollum event is ever missed, and it keeps the repository active so GitHub doesn't disable its scheduled workflows after 60 days of inactivity.
  • Manually, from the Actions tab of the docs repository -> BuildDocs -> Run Workflow. Useful if you want to force a rebuild without waiting, or need the "check external links" option (which the automatic triggers skip, since it takes about 1.5 hours).

Either way, once a build starts it takes about 6-10 minutes to finish and go live.

What if my new page doesn't show up?

sitesdefinitions.json only includes pages it's explicitly told about. If your new page is linked to from a page that's already in the docs site, an auto-registration step (apply_new_pages.py) will pick it up automatically on the next build. If it isn't linked from an included page, it won't appear until someone adds an entry for it to sitesdefinitions.json -- see DelphinDocsReference.md for how.

If a page that was included gets deleted or renamed, the same script removes its stale entry automatically (after it's been missing for two builds in a row, as a safety margin) rather than breaking the whole site build.

History

This page previously described the old (pre-2023) build process, which published a small, hand-picked set of pages directly from the docs repository whenever it was pushed to, with no wiki integration. The current pipeline (Jekyll + sitesdefinitions.json + auto page registration) replaced it -- see ERDW_StructureForNewDocsSite for the original design rationale.