docs/README.md

# 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 seven 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.
release: v0.11.0 (#459) Ships `dev` as v0.11.0. `main` contains nothing that `dev` does not, so this is a clean sync. ## Headline changes since v0.10.0 - Journal & Journal Studio — photo essays at `/journal`, split-screen block editor with live preview, drafts, per-entry passwords, cover images - First-run setup wizard at `/install` — configure a fresh deployment from the browser; credentials are verified against Immich before anything is written, and the wizard is gated by a one-time token - About page editor and toggle in the admin panel - Per-album photo order independent of Immich, with a drag & drop editor - Custom favicon upload - Experimental portfolio features — justified grid, `cover` hero, unlisted subpages, per-album grid overrides, cover focal points, external nav links - Security — asset tokens length-capped before decoding (#423), journal author markdown escaped rather than filtered, journal file paths contained, admin session key derived with scrypt (#432), Next.js 16.3.0 for CVE-2025-13465 - Fixed — client proofing honours its own configuration again (#454); journal photo rendering (#432) Full detail in [CHANGELOG.md](CHANGELOG.md#0110--2026-08-15). ## Verified `npx tsc --noEmit` clean · `npx vitest run` 435 tests pass · `npm run build` succeeds · lint 0 errors · `prettier --check` clean · local `docker build` of the release tree. ## After merge Tag `v0.11.0` on `main` and publish the release — that triggers `docker-publish.yml`, which pushes the image and moves `latest`. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: ralksta <ralksta@users.noreply.github.com> Co-authored-by: lancetm714 <108419425+lancetm714@users.noreply.github.com> Co-authored-by: Claude Opus 5 <noreply@anthropic.com> 2026-08-15 09:09:18 +02:00			`# 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 seven 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.