Repository navigation
Wiki Maintenance
Navigation guide, not a versioned contract. This page tracks
dmarcgov3. Repository source and the publishing workflow define the wiki content.
The Markdown files under
docs/wiki
are the only editable source. Do not edit the rendered GitHub wiki directly
after its initial bootstrap page has been created.
- Edit the repository source in a normal pull request.
- Run
make wiki-checklocally. - Let pull-request CI validate navigation, required sections, repository links, filenames, and common sensitive-data markers.
- Merge only after normal review and CI.
- The trusted
mainworkflow replaces the wiki contents deterministically and publishes only when source changed.
Pull requests receive read-only repository access and never publish. Publishing
runs only for trusted main or a manually dispatched trusted revision, uses the
workflow's short-lived GitHub token, and requests write permission only in the
publish job. The repository keeps normal wiki editing restricted to
collaborators.
GitHub does not create the wiki Git repository until an initial page exists.
An administrator creates a temporary Home page once, then runs the trusted
publish workflow to replace it from canonical source. If automated publication
is unavailable, an authorized maintainer may run scripts/publish_wiki.sh
locally with their existing Git credentials. Do not add a long-lived wiki token
or personal access token to pull-request workflows.
Wiki examples remain synthetic by default. An explicitly owner-authorized point-in-time summary may identify the maintainer's domain, but never add raw report contents, source IPs, contacts, credentials, local paths, private configuration, or private provider overlays to the wiki.
This wiki is a navigation layer for the current dmarcgo v3 line. Repository documentation is authoritative.