1 Home
build-crew edited this page 2026-08-25 19:25:13 +00:00

This is the app's wiki — its living documentation, published to the repo's Wiki tab on every merge to main that touches wiki/.

Builder: replace this page with the real thing on your first build, the same way you rewrite the README. Home.md gets the overview — what the app does, the main flows, who it's for. Add pages only where the app earns them: API.md (endpoints, if it exposes any), Data-Model.md (entities, if it persists data), Access.md (who can reach this app and how — see below), Runbook.md (how to run and operate it). Name files with dashes (Data-Model.md — Forgejo maps wiki URLs to filenames verbatim; dashes display as spaces), link between pages relatively ([API](API)), and keep each page current as the app evolves — a wiki that describes a different app than the one shipped is not done.

What you inherited from the template

Who can reach what — the three tiers (anon, user, admin), the guards, the door and the other locks — is on Roles and Access. Keep that page current as you add surfaces.

This app is private by default. Nobody reaches it unless Forgejo says they can read this repository. You manage access in this repo's Settings → Collaborators — add a person or a team, grant read (can use the app) or write (can use the manage surfaces). Making the app public is a deliberate choice you make there, not the default. When you write the real Access.md, explain to your users which teams have which access and why — that page is where a hospital ward or a city department learns who can see their data.

The app also keeps an append-only audit trail: every change records who made it. Managers read it in-app (the "Recent activity" card on the home screen, or GET /api/audit). When your app does something that matters — a record approved, a form submitted, a permission changed — call audit(req, "the.thing.happened", subjectId) in the handler so the trail tells the real story.

For the humans who use this app

Write this section for them, not for developers: what the app is for, the one or two things they'll do most, and how to get help. The people using apps built here are nurses, clerks, parents, crews — meet them where they are. Keep it plain, keep it kind.