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

Docs pages harder to follow than older wiki pages #221

Closed
Bowswa opened this issue Nov 27, 2024 · 3 comments
Closed

Docs pages harder to follow than older wiki pages #221

Bowswa opened this issue Nov 27, 2024 · 3 comments
Labels
improvement A new addition to an already existing page needs-discussion Further discussion is needed

Comments

@Bowswa
Copy link

Bowswa commented Nov 27, 2024

I am still very new to modding, and only made a couple basic blocks using the old wiki pages. It took me about 30 minutes to figure out how everything worked, and even go ahead and do a test boot with everything working. By the time i booted, i understood everything very clearly.

On the new docs pages, I am struggling. A lot. I've been here an hour, having done the ADHD drop the mod efforts, and forgotten everything from the last time. I also somehow lost my old mod haha.

The main problem stumping me is what values am i supposed to replace with values specific to my mod? It was really clear on the wiki, but not so much on the docs. I don't understand what is going on, and can't make a working mod at this time. I would like this issue to be improved upon, but i will say the docs are looking great otherwise.

@its-miroma its-miroma added improvement A new addition to an already existing page help-wanted Anyone is welcome to work on this needs-discussion Further discussion is needed labels Nov 27, 2024
@its-miroma
Copy link
Member

Thank you for your feedback.
We are considering some changes to class names (see issue #162) which may make code clearer. We also want to make it clear that a fully-working mod is available in this repository (tested and built successfully).
Please provide more precious feedback

@Bowswa
Copy link
Author

Bowswa commented Nov 29, 2024

I see the feedback provided in the other ticket, i think it might be considered replacing such values with "YOURMODID", and "YOURBLOCK", and "YOURINITCLASS" and such, making it even clearer than even the wiki was.

@its-miroma
Copy link
Member

Duplicate of #162

@its-miroma its-miroma marked this as a duplicate of #162 Nov 29, 2024
@its-miroma its-miroma closed this as not planned Won't fix, can't repro, duplicate, stale Nov 29, 2024
@its-miroma its-miroma removed the help-wanted Anyone is welcome to work on this label Dec 30, 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

2 participants