Files
allstarr/docs

Allstarr documentation

User and operator guides describe shipped behavior. Contributor assessments explicitly distinguish current implementation from proposed work. Start with one audience and follow links to the owning document instead of reading the whole tree.

Start here

Operator guides

Contributor guides

Documentation rules

  1. User and operator guides describe current behavior only. Contributor plans must lead with a visible status and must not read like shipped setup instructions.
  2. Link to the owning code instead of duplicating long lists that can drift.
  3. Keep deployment choices in operator guides and unfinished work out of public user documentation.
  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.