# Documentation

Start at the [project README](../README.md) for the pitch, the feature list and
a quick start.

## Guides

| Guide                                          | Covers                                                                                                                  |
| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **[Gallery Configuration](gallery-config.md)** | `gallery.yaml` and `settings.yaml` — albums, subpages, sections, photo order, passwords, grid, SEO, proofing, watermark |
| **[Theming](theming.md)**                      | The twelve presets, custom colours and fonts, hero styles, grid layouts, with screenshots                               |
| **[Journal & Photo Essays](journal.md)**       | Long-form storytelling — file format, block syntax, drafts, per-entry passwords, Journal Studio                         |
| **[Admin Panel](admin-panel.md)**              | The visual editor at `/admin` — pages, journal, settings, analytics, backups, security                                  |
| **[Deployment](deployment.md)**                | Setup wizard internals, Docker, health check, reverse proxy, behaviour during an Immich outage                          |

Contributing? See [CONTRIBUTING.md](../CONTRIBUTING.md). Security policy:
[SECURITY.md](../SECURITY.md). Release history: [CHANGELOG.md](../CHANGELOG.md).

## Design notes

Working documents kept for context. They record thinking at a point in time and
are **not maintained** — where they disagree with the guides above, the guides
are correct.

- [brainstorm.md](brainstorm.md), [brainstorm-2026-08-05.md](brainstorm-2026-08-05.md) — feature brainstorming
- [deep-dive-2026-08-05.md](deep-dive-2026-08-05.md) — architecture review
- [ideas.md](ideas.md) — unsorted ideas backlog
- [journal-studio-design.md](journal-studio-design.md) — design notes for the journal editor

`screenshots/` holds the images used by the guides and the README.