replace big-tech and host basic infrastructure yourself! ordner.fyi

docs/manuals: the user manual and the admin manual #24

Merged pipobscure.com
targeting main from feature/manuals
Merged opened by and assigned to pipobscure.com
targeting main from feature/manuals

Two handbooks for a running instance, as a collection of interlinked markdown files — the first deliverable of the manuals project. Later these convert into online documentation served by the instance itself, with the hostname replaced from a placeholder at render time.

The placeholder convention: every URL carries {host} for the instance's base hostname — https://{host}/mail/, https://docs.{host}/, subdomains following the same pattern. Documented in docs/manuals/README.md; nothing in the text changes at conversion time.

The user manual (docs/manuals/user/, nine pages) — for everyone with an account: getting started, the four areas (mail, calendar, contacts, files) in the web interface, documents, sharing, and the credentials that connect desktop and mobile applications (app passwords with scopes, IMAP/SMTP/CalDAV/CardDAV/WebDAV settings, the ordner CLI).

The admin manual (docs/manuals/admin/, eight pages) — for the person administering an instance: the architecture (the services, the stores, the flows), installation as the administrator's three phases, what the configuration's settings mean and how they connect, accounts and scopes, the recurring operations, the security model including the document server's lockdown, and troubleshooting with the second-client rule.

House rules honored: the repo's documentation conventions — one fact one home (the manuals link to design/, areas/ and operations/ instead of restating), present tense, and the manuals' own rule that a concrete hostname in these files is a bug.

Commits 0