Skip to content

Maintaining the Wiki

Robin Müller edited this page Jul 30, 2026 · 1 revision

Maintaining the Wiki

The wiki is a separate Git repository:

git clone git@github.com:DerRobin99/smart-drink-fridge.wiki.git

Release checklist

For every release:

  1. Update version.py
  2. Add the release to the README changelog
  3. Remove completed items from ROADMAP.md
  4. Update affected wiki pages
  5. Verify commands against the current Compose files
  6. Push main
  7. Create and push the version tag
  8. Publish the GitHub release
  9. Confirm both latest and versioned container builds

Documentation principles

  • Keep setup commands copyable
  • Document safe defaults first
  • Put security warnings next to sensitive commands
  • Never include real .env secrets
  • Prefer links between focused pages over one oversized page
  • State the release version on Home

Wiki changes should use clear commit messages, for example:

git commit -m "Document version 1.4.0"
git push

Clone this wiki locally