Start with the README: what you need, the rules, and how to push and mount an image.
| Page | Read it when |
|---|---|
| cli.md | you run settings-image by hand or in a CI other than GitHub Actions: every flag, credentials, the --json output, exit codes |
| github-action.md | you publish from GitHub Actions: every input and output, other registries |
| flux.md | you want new settings to roll out by themselves, with Flux image automation |
| alternatives.md | you wonder why this exists: images versus artifacts, what Docker, ORAS and Flux produce, prior art, and the other ways settings reach a pod |
| digests.md | you want to understand digests: what is in an image, why the same files give the same digest, what that buys, and where provenance lives |
| Page | Read it when |
|---|---|
| plan.md | what is done, and what to build next |
| format-v2.md | you write or read image bytes. The contract, with known-answer digests |
| background.md | you wonder why a rule exists: what image volumes need, and what was measured |