Skip to content

Add documentation on creating a mod and the fields a mod contains#1328

Open
EmeraldLoc wants to merge 7 commits into
coop-deluxe:devfrom
EmeraldLoc:docs-mod-stuff
Open

Add documentation on creating a mod and the fields a mod contains#1328
EmeraldLoc wants to merge 7 commits into
coop-deluxe:devfrom
EmeraldLoc:docs-mod-stuff

Conversation

@EmeraldLoc

Copy link
Copy Markdown
Collaborator

Title. You can view the doc file here

https://github.com/EmeraldLoc/sm64coopdx/blob/docs-mod-stuff/docs/lua/guides/creating-mod.md

Also minority adjusts vscode doc to have lua color highlighting

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 36310fb7-943c-4c68-92c3-7d381057da98

📥 Commits

Reviewing files that changed from the base of the PR and between daf2b22 and 8e54699.

📒 Files selected for processing (1)
  • docs/lua/guides/creating-mod.md

📝 Walkthrough

Walkthrough

A new documentation page docs/lua/guides/creating-mod.md is added, providing a step-by-step guide for creating Lua mods in sm64coopdx. It covers navigating to the mods directory, choosing between file mods and folder mods, platform-specific .lua file creation, setting up main.lua for folder mods, and configuring comment-based metadata fields. Two bullet links to this guide are added in docs/lua/lua.md under the Tips and Guides sections. A code-fence formatting error in docs/lua/guides/vs-code-setup.md is also corrected.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding documentation on creating a mod and its fields, which is the primary purpose of the PR.
Description check ✅ Passed The description is related to the changeset, mentioning the new documentation file and the VS Code documentation adjustment, though it could be more detailed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/lua/guides/creating-mod.md`:
- Line 31: Apply the following textual corrections to the documentation:
capitalize "Windows" as a proper noun where it appears in the platform
instructions section, add hyphens to compound adjectives such as "worst-case
scenario" and "opt-in system" to follow professional documentation standards,
and fix the grammatical error in the categories description by replacing "Do not
categories are all lowercase" with "Categories are all lowercase" or "Note that
categories are all lowercase" for proper sentence structure.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: faed2533-07cd-452e-a6c1-e60441cab12d

📥 Commits

Reviewing files that changed from the base of the PR and between 94c163c and 038fb33.

📒 Files selected for processing (1)
  • docs/lua/guides/creating-mod.md

Comment thread docs/lua/guides/creating-mod.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant