Skip to content

Documentation governance

These guides cover the rules Praetor's own documentation follows: the Markdown gate, the check that surface changes ship their documentation, the voice each kind of text uses, and how the wiki is published.

Read Documentation governance first.

  • Documentation governance: the locked Markdown gate, its formatting rules and the check for links into private session artifacts.
  • Documentation drift: praetorctl docs references --base=<rev> requires a documentation change with every change to a surface that docs_surfaces in .standards.yaml declares, in Praetor and in any adopted repository.
  • Text register: the register: policy that names the voice for forge, documentation and agent text.
  • GitHub wiki sync: how docs/wiki/ is mirrored to the repository wiki and how pages it no longer carries are removed.