Skip to content

Nerthus.Docs

This site: the documentation of the whole estate, and the one repository whose output is prose.

What it owns

  • docs/ - every page in every tab.
  • zensical.toml - the nav, which is also the site's reachability contract: a nav entry with no file fails the build, and a file with no nav entry fails nav-coverage.
  • data/nerthus.yml - the Jinja variables: addresses a page must not get wrong and must not restate. An undefined variable fails the build rather than publishing a blank.
  • data/census-*.yaml - the census of every page: its tab, whether it describes Nerthus.Core or the estate, and the retired words it uses.
  • ci/ - the checks, and generate-glossary.py, which writes docs/glossary.md from the workspace's GLOSSARY.md.
  • requirements.txt - the Zensical version the site is built with, pinned.

When a page and the code it describes disagree, one of them is a bug, and which one is a decision somebody takes deliberately.

Where its CI runs

Every merge request and the default branch run these jobs; pages publishes the default branch to cognition.nerthus.pl.

Job What it refuses
docs-build-check, pages a site that does not build under --strict
regime-digest a regime digest in CLAUDE.md that is emptied or loses its load-bearing sentence
ci-lanes a CI file that admits no merge request
nav-coverage a page no tab reaches, and an API page its index does not list
hub-inventory a Hosting hub that stops listing every runbook
addresses an address data/nerthus.yml holds, hand-typed; an address in it nobody declared
cmdlet-names a table row naming a Core cmdlet that does not exist
capability-catalogue a capability list that disagrees with Core's grantable set
docs-literals a Core schema version or cron that disagrees with the file that owns it
docs-illustrations a number in a Core response illustration that nothing asserts
reference-tables a Core reference table that is not the one its generator writes

The last five guard pages in the Nerthus.Core tab and are removed with it.

What pins to it

Nerthus.Core's test job clones this repository at the branch name it is building. A page added or removed under docs/reference/api/ needs a paired row in Core's tests/doc-examples-declared.psd1, on a branch of the same name. Nerthus.Platform and Nerthus.Config cite pages here by URL, so a page they cite keeps its path.

What breaks if it stops

No machine stops. The site goes stale, which is the slower failure: a page that is wrong reads exactly like a page that is right.

See also