Wiki / About this wiki / How to write a guide
How to write a guide
Last touched 17 November 2026
A guide is one Markdown file in the folder of its category, for example
content/wiki/telephones/my-guide.md. The file name becomes the address.
The top of the file
+++
title = "What the guide is called"
description = "One line for the lists and the search results."
date = 2026-11-17
+++
title is required. description shows up next to the title in every list. date is printed as "last
touched"; change it when you rework the guide, or leave it out.
The rest
Ordinary Markdown: headings with ##, lists, tables, code in backticks. The building blocks from the
main site work here too; the sampler shows all of them.
Careful. A guide with a typing mistake in its top block stops the whole build. The Actions log names the file and the line.
Getting it published
Commit, then run push-to-test from the repository's Actions tab and look at it on construction.512mb.net. When it reads well, run push-to-prod.
More in About this wiki /// all guides