Maintenance
The docs are plain static pages.
This keeps deployment simple: the existing Go file server can serve them from /doc/.
Add A Page
- Create a new HTML file in
web/doc/. - Use the same header, layout,
data-doc-navnav element, andassets/docs.css. - Add the page to
web/doc/assets/docs.js. - Link related feature pages to each other where a user would naturally need context.
Writing Rules
- Document current behavior first, then future plans clearly as future plans.
- Prefer examples users can paste into the client.
- When a feature changes, update both its feature page and any linked examples.
- Keep feature pages focused. Create a new page when a feature grows too large.
Useful Cross-Links
Triggers often link to Variables and Activity. Aliases often link to Variables. Lua planning should link to all automation pages.