Common Project

Shared Roblox modules for the development team. The repository uses Moonwave to generate API docs from Luau source comments.

Moonwave workflow

• moonwave.cmd dev --code src – local preview with live reload (press Ctrl + C to stop). Use this while editing doc comments.
• moonwave.cmd build --code src – produce a static site in build/. The folder is ignored from source control; deploy it manually or with GitHub Pages.

Authoring documentation

1. Write Moonwave doc comments directly above classes, functions, and properties. Use tags such as @class, @function, @within, @param, @return, and @tag.
2. Add narrative guides in docs/. The starter page lives at docs/intro.mdx.
3. Update moonwave.toml if you want to tweak navigation, homepage content, or repository metadata.

Tip: Keep section dividers like ----- Example ----- inside -- comments (for example -- ----- Example -----) so the extractor reads them as comments.

Known caveats

The first moonwave build may report errors for legacy separator lines (for example at src/ServerScriptService/Services/ProfileService/ProfileStore/init.lua). Convert those separators into standard -- comments or remove them before retrying.