Skip to content

Conversation

@dicedpixels
Copy link
Contributor

@dicedpixels dicedpixels commented Sep 9, 2025

fix #162

The current mod ID fabric-docs-reference and its Java form FabricDocsReference have been a confusion for new mod developers. Many have assumed it's one of Fabric's inbuilt class/constant.

This PR changes the mod ID to example-mod and ExampleMod. There were a couple of fabric_docs_reference which I have changed to example-mod as well.

I have tested many things best to my ability, as well as verify the docs as much as possible.

I'll leave this PR as a draft for comments/ larger change requests for a while, given the size of it.

@netlify
Copy link

netlify bot commented Sep 9, 2025

Deploy Preview for nimble-elf-d9d491 ready!

Name Link
🔨 Latest commit a73e85e
🔍 Latest deploy log https://app.netlify.com/projects/nimble-elf-d9d491/deploys/68ec03d7a4fe90000898762d
😎 Deploy Preview https://deploy-preview-357--nimble-elf-d9d491.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@its-miroma its-miroma added improvement A new addition to an already existing page needs-discussion Further discussion is needed todo:expand This should be expanded priority:low This is nice to have, but it can wait a little labels Sep 9, 2025
@its-miroma its-miroma removed the priority:low This is nice to have, but it can wait a little label Sep 17, 2025
* upstream/main:
  Update rendering concepts page (FabricMC#362)
  "Setting up a Development Environment": VS Code (FabricMC#360)
  Running Game Tests In Github Actions (FabricMC#338)
  Items: Item Models (FabricMC#324)
  Call `.useBlockPrefixedTranslationKey()` (FabricMC#358)
  Clarify that `mod-id` placeholders must be customized (FabricMC#348)
  replace remaining mentions of tickDelta with tickProgress (FabricMC#361)
  Project location (FabricMC#326)
  improve the first items docs to state what's needed for item appearance, link fix (FabricMC#359)
@its-miroma its-miroma added todo:cleanup This should be cleaned up and removed todo:expand This should be expanded labels Sep 27, 2025
- "mod_id" -> "example-mod"
- "modid" -> "example-mod"
- "i-am-your-mod-id" -> "example-mod"
- use "my-cool-mod" in develop/getting-started/creating-a-project.md
* upstream/main:
  Update Docs to 1.21.10 (FabricMC#369)
  uniform sidebar translations keys (FabricMC#370)
  fix image z-index (FabricMC#368)
  Blocks: Block Models (FabricMC#364)
  Split IDE-Specific Pages (FabricMC#366)
  Notes on Creating a Project (FabricMC#367)
  Rendering in the world and custom render pipelines (FabricMC#365)
@its-miroma its-miroma marked this pull request as ready for review October 12, 2025 19:44
@its-miroma its-miroma requested review from a team as code owners October 12, 2025 19:44
@its-miroma its-miroma added stage:ready and removed todo:cleanup This should be cleaned up labels Oct 12, 2025
@dicedpixels
Copy link
Contributor Author

Did some quick tests on the 1.20.4 and 1.21 reference mods as well. Didn't notice anything broken.

@modmuss50
Copy link
Member

Impossible to review, I trust its correct. Feel free to merge and fix any issues in a followup pr.

Copy link
Member

@cassiancc cassiancc left a comment

Choose a reason for hiding this comment

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

Echoing modmuss, this is a good change that's impossible to review. If anything slips by, it can be fixed in a later PR.

@cassiancc cassiancc merged commit d93d033 into FabricMC:main Oct 13, 2025
8 checks passed
kevinthegreat1 pushed a commit to kevinthegreat1/fabric-docs that referenced this pull request Oct 14, 2025
Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com>
(cherry picked from commit d93d033)
kevinthegreat1 pushed a commit to kevinthegreat1/fabric-docs that referenced this pull request Oct 14, 2025
Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com>
(cherry picked from commit d93d033)
kevinthegreat1 pushed a commit to kevinthegreat1/fabric-docs that referenced this pull request Oct 15, 2025
Co-authored-by: Miroma <136986257+its-miroma@users.noreply.github.com>
(cherry picked from commit d93d033)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement A new addition to an already existing page needs-discussion Further discussion is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use ExampleMod instead of FabricDocsReference

4 participants