메뉴
Write or edit documentation in this repo — moonwave API docs, doc comments, or guide pages. Use when asked to document an API, add a guide, fix docs, or preview the docs site. Covers moonwave comment forms, guide-file conventions, classOrder registration, and previewing.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
Work on the coverage system itself under tools/coverage (Rust full_moon engine or Lune orchestrator). Use when modifying instrumentation, probes, mutation testing, the report, adapters, or when golden tests fail. Covers building, testing, golden regeneration, and layout boundaries.
Create a new Wally package under lib/ in this repo. Use when asked to scaffold, add, or create a new package/module/library. Covers the scaffold script, the pure-Luau vs datamodel entry-point decision, and post-scaffold registration steps.
Publish or version-bump a Wally package in this repo. Use when asked to publish, release, or bump a package version. Covers the publish script's non-interactive flags, the auto-generated init.luau, and CI workflow actions.
Run tests and coverage for a package in this repo. Use when asked to run tests, check coverage, run the test suite, or verify a package's specs pass. Covers command forms, flags, pipeline selection (Lune vs Roblox Studio), and reading the output.
Write or modify tiniest test specs (.spec.luau) in this repo. Use when adding tests, fixing failing tests, or improving coverage for a package. Covers spec structure, the expect matcher API, snapshots, Roblox class shims, and the FakeIntermediary bridge for replicator tests.
| name | write-docs |
| description | Write or edit documentation in this repo — moonwave API docs, doc comments, or guide pages. Use when asked to document an API, add a guide, fix docs, or preview the docs site. Covers moonwave comment forms, guide-file conventions, classOrder registration, and previewing. |
The docs site is built by moonwave from doc comments in package source,
deployed to raild3x.github.io/ModulesOnRails. Config: moonwave.toml.
-----[=[ ... ]=] with moonwave tags
(@class, @within, @param, @return, @prop, @yields, @private, @ignore)-- / --[[ ... ]]@ignore in their class block so they stay out of the site.Follow the existing doc style of the package you're in; lib/tablemanager/src/
is the richest example set.
Long-form guides are doc-comment-only .luau files (no runtime code)
under the package's src/Docs/, named with the package prefix:
lib/tablemanager/src/Docs/TM_Getting_Started.luau,
lib/tablereplicator/src/Docs/TR_Custom_Remotes.luau, etc.
A new guide must be registered in moonwave.toml under the package's
[[classOrder]] — guides go in the nested [[classOrder.items]] block with
section = "[Guides]". Unregistered classes still render but land unsorted.
Plain .md files in src/Docs/ (e.g. CONTRACT.md, ARCHITECTURE.md) are
internal/contributor docs, not part of the moonwave site.
npm run docs # moonwave dev server (runs `npm run clear` first!)
npm run docs:build # static build
Warning: both commands run npm run clear first, which strips installed
wally deps from every package — types/requires will look broken afterward
until npm run setup is re-run. Don't panic; it's expected.
The root README.md is generated from every wally.toml by npm run readme
— never hand-edit it. Package descriptions come from wally.toml
description; display name and docs link from [custom] formattedName /
docsLink.