Prompt Wizard SSOT

2 min read

📚 Wiki Publish

The wiki root is ${WIKI_ROOT}. The content root is ${WIKI_ROOT}/content. Quartz config already exists; this page covers content and information architecture only.

Required files

  • ${WIKI_ROOT}/wiki-ia.json
  • ${WIKI_ROOT}/content/index.md
  • ${WIKI_ROOT}/content/architecture/index.md
  • ${WIKI_ROOT}/content/architecture/runtime.md
  • ${WIKI_ROOT}/content/architecture/omp-integration.md
  • ${WIKI_ROOT}/content/architecture/data-model.md
  • ${WIKI_ROOT}/content/operations/index.md
  • ${WIKI_ROOT}/content/operations/deploy.md
  • ${WIKI_ROOT}/content/operations/wiki-publish.md
  • the verification runbook in the wiki private area
  • ${WIKI_ROOT}/content/reference/index.md
  • ${WIKI_ROOT}/content/reference/api.md
  • ${WIKI_ROOT}/content/reference/admin-prompts.md
  • ${WIKI_ROOT}/content/reference/settings.md
  • ${WIKI_ROOT}/content/history/index.md
  • ${WIKI_ROOT}/content/history/imported-notes.md
  • ${WIKI_ROOT}/content/history/backlog.md
  • ${WIKI_ROOT}/content/history/changelog-archive.md
  • ${WIKI_ROOT}/content/history/docs-vs-reality.md

Frontmatter rule

Every markdown page must include:

title: <page title>
description: <one sentence>
source: <evidence source>
reviewed: <date>

Directory rule

Every directory under content/ needs an index.md page. wiki-ia.json keeps index_exempt_dirs empty.

Content hazards

  • never publish machine-specific absolute home paths
  • never publish loopback host strings in prose or examples
  • avoid secret-shaped examples
  • do not put unsafe wikilink aliases inside markdown tables
  • avoid slash-heavy aliases; use plain wikilinks such as [[architecture/omp-integration]]
  • distinguish target architecture from verified repository reality

Publish order

  • run wikilink pre-publish scan
  • run check-only wiki build
  • run real wiki build
  • confirm ${WIKI_ROOT}/current points at a fresh build output
  • confirm https://wiki.pwiz.loca.zone responds successfully
${WIKIS_ROOT}/scripts/wikilink-scan pwiz
${WIKIS_ROOT}/build.sh pwiz --check-only
${WIKIS_ROOT}/build.sh pwiz

Parent orchestration validates this assignment; page authors do not run build or validation for this task.

Access model (d160)

  • The wiki is public: build.sh pwiz emits everything except the content/private/ directory, which ignorePatterns excludes from the build and index entirely.
  • Pages under content/private/ ship only in the private build (pwiz-private, same content symlink, baseUrl: wiki.pwiz.loca.zone/private), served at https://wiki.pwiz.loca.zone/private/ behind Authelia; nginx enforces it with an auth_request on location ^~ /private/.
  • Public pages must not link to private page slugs; link to the area root (/private/) with a login label instead. The build gate greps the whole dist for private page slugs and must find zero matches.
  • New private pages: add the file under content/private/, add it to required_pages in wiki-ia.json, and rebuild both wikis.