Update wiki.json to include new wiki pages
TheBusyBiscuit opened this issue ยท 4 comments
This Issue is part of Hacktoberfest - A yearly event which encourages participation in the open-source community. Sign up on their website and submit four pull requests during october (Oct 1st - Oct 31st) to any public open-source project on GitHub and earn a limited-edition T-shirt or plant a tree!
๐ Scope
The following bullet points explain what the scope of this feature should be.
It should give a general idea of what we want, you can of course deviate from this as needed.
- The wiki.json is a file which maps slimefun item ids to their corresponding wiki page.
- This file hasn't been updated in a while despite there being lots of new wiki pages
โ Difficulty
Here is our honest estimate on how difficult (on a scale of 1-5) the implementation may be:
๐ตโชโชโชโช
๐ง Technical Challenges
These are some challenges which may need to be overcome, we wanna be as transparent as possible, so here is some guidance on what may present itself as an obstacle.
None, this is pretty straight-forward, you just gotta stick to the json format.
๐ Relevant Classes or Snippets
Here are some classes or code snippets which we think might help you get a better understanding where to look for in this gigantic codebase
- Wiki: /pages/ - This is a list of all wiki pages
- SlimefunItems.java - Here you can find all Slimefun item ids, they are the first argument in the
SlimefunItemStack
constructor
๐ Useful Resources
If you need help on how to get started, maybe try looking into the following resources!
- Hacktoberfest
- GitHub/Open-Source
- Slimefun
If you want to work on this, simply comment down below and state your interests! Please also comment again if you have changed your mind. Anyone is allowed to discuss in the comments below, feel free to collaborate and work together โค๏ธ
You can always ask for help here if you get stuck.
Hello @TheBusyBiscuit , I would be glad to contribute to this, shall I? The codebase is quite large so may take sometime to familiarize with it ๐
@comrade-om Sure, you're welcome :).
By the way this particular issue does not require any coding skills at all, it's just about adding missing entries to the wiki.json file, want me to assign you to this?
@TheBusyBiscuit Please review my PR ๐