Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use terms like ExampleMod instead of FabricDocsReference for clarity #162

Open
hiisuuii opened this issue Aug 13, 2024 · 1 comment
Open
Labels
improvement A new addition to an already existing page needs-discussion Further discussion is needed

Comments

@hiisuuii
Copy link
Contributor

Mentioned in Discord as well - I think it is worth examining whether the docs would be better off using names like example-mod and ExampleModInitializer in the example code rather than fabric-docs-reference and FabricDocsReference. I notice in the mod dev channels, that it seems to be a pretty common point of confusion. Many newcomers have been asking questions such as "what is FabricDocsReference?" and "where do I find FabricDocsReference?" because it is not immediately clear that these classes and names should be replaced with THEIR mod's ModInitializer class. I think the presence of "Fabric" in the class name causes people to believe it is some class provided by the API, rather than a class from their mod/the example mod.

@IMB11
Copy link
Member

IMB11 commented Aug 13, 2024

We're definitely considering this.

@IMB11 IMB11 added the improvement A new addition to an already existing page label Aug 13, 2024
@its-miroma its-miroma added the needs-discussion Further discussion is needed label Oct 17, 2024
@its-miroma its-miroma pinned this issue Oct 28, 2024
@its-miroma its-miroma changed the title Docs may be more easily understood by using terms such as ExampleMod instead of FabricDocsReference Use terms like ExampleMod instead of FabricDocsReference for clarity Oct 28, 2024
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

No branches or pull requests

3 participants