documentation

Documentation that is reviewed, tested and therefore still true.

• Documentation as a Repository: Publishing a Wiki.js Site from Reviewed Markdown

  1 September 2026 documentation testing ci-cd architecture

  Documentation kept in a hosted wiki drifts silently, because nothing forces a reviewer to look at it when the code it describes changes. Treating docs as a repository, reviewed through the same pull requests as code, turns that silence into a diff someone has to look at. This covers what changes when documentation moves into git — as it does in the open-source OpenTaberna project — with a runnable Wiki.js setup and a CI check that fails a pull request when source changes without its docs.

• Keeping Documentation Honest with an OpenAPI Snapshot Diff

  25 August 2026 documentation testing ci-cd

  Hand-written API documentation and the code behind it drift apart silently, because nothing runs the docs to notice. This article generates the real OpenAPI schema from a FastAPI app, commits a normalised snapshot, and fails CI the moment the two disagree, with the full app, test and workflow.

All topics · All writing