Editing this documentation

This documentation site is edited in the browser, not in a code editor. The pen icon in the dashboard top bar — titled “Documentation editor” and visible to staff only — opens the editor at /admin/. Changes are written as Markdown to the private Homeward-Missions/homeward-docs repository.

The review workflow

Drafts do not go straight to the site. The editorial workflow stores them on branches and opens a pull request; publishing merges the reviewed change into main, and Cloudflare then rebuilds docs.homeward.org. Nothing readers can see changes until the merge.

Uploaded images are stored with the documentation source, so screenshots travel with the article.

What Markdown supports

Headings, lists, tables, links, callouts, code blocks, and images. Callouts (:::note, :::tip, :::caution, :::danger) are for things the reader must not miss — one or two per article at most.

House style

A few rules keep the set readable and are worth following in every edit:

Write in the second person, present tense, plain and warm. No exclamation marks, no marketing language, no “simply” or “just”.
Start with one or two sentences saying what the page is for. Frontmatter carries the title and a one-sentence description written for search results.
One H2 per task or area, short paragraphs, and the answer before the caveats.
Bold every UI label exactly as it appears in the product, and use the product’s own vocabulary rather than a synonym.
Any field or toggle whose meaning is not self-evident gets a short description — what it does, whether it is public, and any limit the reader will hit.
Keep articles focused on Homeward-specific concepts and behaviour. Do not add instructions for conventional interactions the interface already makes clear.
End with a short “Related” paragraph linking to two to four other articles, using site-absolute links such as /administration/overview/.