PhilippTheServer

documentation

Documentation that is reviewed, tested and therefore still true.

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

    Wiki.js Git storage for docs as code: publish reviewed Markdown and fail a pull request when src/ changes without docs/, checked with git diff.

  2. Keeping Documentation Honest with an OpenAPI Snapshot Diff

    FastAPI app.openapi() snapshot test in pytest: fail CI when the live OpenAPI schema drifts from the committed openapi.snapshot.json.

All topics · All writing