Builtin Library
- ..
- README.md929 B
- about.yaml548 B
- behavior.luau2.5 KB
- inspector.luau1.4 KB
- template
- type.yaml2.3 KB
README.md
guide
A guide is a single-file documentation asset: a <name>.guide/ folder whose body is guide.md, surfaced through the guides MCP tool, the man shell builtin and the Docs panel. Drop one anywhere under /zero/source/, a .package included, and it shows beside the built-in guides.
Linking guides together
A markdown link in a guide is followed when it is clicked in the Docs panel: [Bindings](controls-guide) opens another guide by any name guides read takes, [Slots](#save-slots) a heading of the same guide (its text in lower case, punctuation removed, spaces turned into -), [Slots](save-kit#save-slots) a heading of another, and [the module](../saveKit.module) a file or asset, relative to the guide's own folder. A link the panel cannot follow says why above the guide.
In the Inspector
Guide: the guide's word count, its headings, and Open in Docs, which opens it in the Docs panel.