Improve this manual
Found a mistake, a missing step, or a thing you worked out that others should know? Change the page. Every page of this manual can be edited by anyone with a GitHub account.
How it works
- Click Edit this page at the bottom of a page. The page opens in an editor on the website, with a preview beside it.
- Write your change. Sign in with GitHub when you are ready to send it; your text stays in the browser meanwhile.
- Say in one line what you changed, and click Send for review.
The maintainer reads your change, with your GitHub name on it, and approves it. A few minutes later the page is live. My contributions on the website shows where your change stands, and you get a note when it is accepted, or a word on why not.
Nothing goes live without review, so you can't break anything. A half-finished improvement is still welcome.
Pictures
Add a picture in the editor uploads a PNG, JPG or WebP of up to 4 MB, or drop one on the text. It lands in the text as a line like this, and you replace the words in the brackets with what the picture shows:
A screenshot of the screen itself or of the editor says more than a paragraph. Crop it to what matters, and leave out anything personal, such as names of people or the address of your Home Assistant.
A new page
Start a new page under a section of your choice. A good page explains one thing: what it does, what its options are, what someone sees. Give it a title that says what it is about, as the other pages do.
How to write it
- Plain English, short sentences. Write as you would explain it to a neighbour.
- Name buttons and settings exactly as the app shows them, in bold: Save & send, Standby after.
- Say what a thing does and what someone sees, not how the code works.
- Markdown:
# Heading,**bold**,- a list,[a link](/docs/pages), and::: tip…:::for a box with advice.