Files
allstarr/docs

Allstarr documentation

These documents describe the code that is currently shipped. Planned work does not belong here; implementation planning lives in the ignored apis/steering workspace.

Start here

Operator guides

Documentation rules

  1. Describe current behavior only.
  2. Link to the owning code instead of duplicating long lists that can drift.
  3. Keep deployment choices in operator guides and unfinished work in apis/steering.
  4. Do not document SQLite, Redis, Valkey, AIO images, Compose overlays, bundled extension registries, or automatic legacy-state conversion as supported runtime features.
  5. When code and documentation disagree, fix the documentation in the same completed implementation chunk.