Files

T

Luca ddebd50d3f docs: slim README to a lean router, stage deep content for docs-site migration (#1001 )

Phase 1 of the README slim / docs-migration plan in #1000.

README goes from 577 to ~191 lines: hero, one Quick Start, a Documentation
index, comparison table, tech stack and a table of contents. The deep inline
prose moves into a temporary docs/_to-migrate/ staging folder (webhooks,
storage backends, first-run setup, system requirements, roadmap) so README
links keep resolving until the docs-site pages are live.

Existing docs/*.md referenced by app code are deliberately left in place —
crm-disclaimers.md (frontend TSX, i18n, a backend route and migration),
fonts.md (server.js), accounting-inbound-invoices.md (Dockerfile) and
migration-to-org.md (UpdateNotification.tsx, MigrationBanner.tsx). Moving them
is a separate, code-touching change.

Verified before merge: merges cleanly against main with no conflicts; all 14
in-repo links resolve in the merged tree; no docs file is deleted or renamed;
and the registry-move notice from #995 survives the rewrite in condensed form,
keeping 'still responds but its tags are frozen at 2026-05-27' plus the
migration-to-org.md link. The fuller symptom explanation remains in that doc,
which the README links to.

Follow-up per #1000: port docs/_to-migrate/* into docs.picpeak.app, then flip
the README links and delete the staging folder.

Co-authored-by: Luca-Timo <Luca-Timo@users.noreply.github.com>

2026-08-10 08:16:13 +02:00

first-run-setup.md

docs: slim README to a lean router, stage deep content for docs-site migration (#1001 )

2026-08-10 08:16:13 +02:00

README.md

docs: slim README to a lean router, stage deep content for docs-site migration (#1001 )

2026-08-10 08:16:13 +02:00

roadmap.md

docs: slim README to a lean router, stage deep content for docs-site migration (#1001 )

2026-08-10 08:16:13 +02:00

storage-backends.md

docs: slim README to a lean router, stage deep content for docs-site migration (#1001 )

2026-08-10 08:16:13 +02:00

system-requirements.md

docs: slim README to a lean router, stage deep content for docs-site migration (#1001 )

2026-08-10 08:16:13 +02:00

webhooks.md

docs: slim README to a lean router, stage deep content for docs-site migration (#1001 )

2026-08-10 08:16:13 +02:00

README.md

`_to-migrate` — staging area, not canonical

Warning

These pages were cut out of the root README.md to slim it down. They are being ported to the PicPeak docs site (its own repo → docs.picpeak.app).

Do not edit these files expecting the change to be authoritative — edit the docs-site copy once it exists.

Do not add new links to this folder from code or other docs.

This whole folder is deleted once the docs-site pages are live (see the 3-phase plan in PicPeak/picpeak#1000).

The root README links here only as a temporary bridge so no link 404s while the docs-site pages are being written.

File	Ported to docs.picpeak.app path
`webhooks.md`	`/features/webhooks`
`storage-backends.md`	`/deployment` (storage section)
`first-run-setup.md`	`/deployment` (first run / permissions)
`system-requirements.md`	`/deployment` (system requirements)
`roadmap.md`	project roadmap / GitHub Projects (TBD)

README.md

_to-migrate — staging area, not canonical

`_to-migrate` — staging area, not canonical