Files
photoanalyzer/docs/index.md
domverse adfdf1dbdb
Some checks failed
Test / suites (pull_request) Failing after 3m10s
Test / container (pull_request) Has been skipped
US09-01: Serve the Documentation Inside the Application
2026-08-23 18:45:43 +02:00

1.6 KiB

Photo Pipeline documentation

One local application that takes a photo library from discovery to a verified Immich upload: duplicate detection, safety review, content analysis, album naming, guarded renaming, upload, and archive — one visible, resume-safe workflow.

These pages are readable three ways, and they are the same files each time: in the repository under docs/, on Gitea, and inside the running application under Docs. There is no separate copy to fall out of date.

Read in this order

  1. Overview — what the application does, the stages it moves a photo through, and the rules it will not break.

Being written

The remaining manuals are accepted work, not aspiration; each is a story in E09 and will appear here as it lands.

  • Installation and operations — host and container installation, every setting, the first-run checklist, upgrades, backup and restore, and what each refusal at startup means (US09-02).
  • Architecture — context and runtime diagrams, the module map, the job and journal state machines, and where each invariant is enforced (US09-03).
  • User manual — one page per workflow stage with screenshots of the real application, and a catalogue of every error and refusal (US09-04).

Conventions

A page tells you what a stage changes on disk or on the server before it tells you how to run it. Refusals are documented as intentional: this application would rather stop and explain than guess about somebody's photographs.