Documentation
Page template
Copy this file as the starting point for a new documentation page.
One or two sentences introducing the page. This is the first thing a reader sees under the description, so say what the page is for.
Overview
What this feature is, and when you would reach for it.
How it works
The mechanics. Diagrams, tables and code blocks all work:
-- Code blocks are syntax highlighted.
local example = trueSteps
- First step.
- Second step.
- Third step.
Notes
- Short facts that do not need their own section.
- Constraints, limits, and things that surprise people.
Troubleshooting
Symptom the reader would search for. The cause, and what to do about it.