Contributing to the Wiki
On this page I will quickly go over everything you need to know to contribute to this project.
Requirements
To contribute to this wiki you will need to know how to use GitHub, git, MarkDown, HTML and CSS.
Understanding Java is crucial as you wont be able to get much or niche information without the necessary understanding of the code. The source code can be found here.
A mastery of these topic is not required, for most aspect a solid foundation and the motivation to learn is all it takes.
All the nessery tutorial can be found here:
- git, an interactive website teaching you how to use git
- GitHub, basic understanding of how github works
- MarkDown, this blog has most of what you will need
- HTML, a beginner friendly blog
- CSS, what css is and how to use it
- Java, the basics of programming and java
Git and GitHub are not related, skipping one will leave gaps in knowledge
How to contribute
Fork the Github repository Better with Aether Wiki. Write a page on the topic you like or feels is lacking in information and submit a pull request. Make sure that all conflict are resolved before pushing. We will check and merge the pull request as soon as possible. Be patient we are people to with responsibilities and lives.
Individuals, fetted by the development team, can also submit ready made articles via discord. We wont accept any file from any unfetted individual. Please submit these via GitHub.
Should there be any issue you can contact us on the official BTA discord in the Better with Aether mod channel.
Style Guide
This style guide is based on the BTA-Wiki-Style page. As such this will reiterate some of the more important aspects.
The default the language is the same as BTA as such English (US). Other languages are only allowed if its a transcription.
Contraction like for example "it's" and "they're" must be avoided.
No first or second person perspectives are to be avoided. Keep the wiki neutral and do not generalize. Item, block and entity names are to be capitalized like in-game.
Image captions or alt text should describe their importance to the article.
Why is this not hosted as a Wiki?
A wiki was never planned. The original goal was to port the mod to BTA and nothing more. However over time the project grew and aspect changed and new feature were added. When we have to explain what pendant do for the fifth time, we decided that it was about time to documents those features. This wiki is not meant to be an in depth explanation of any and all mechanics and aspect of Better with Aether. We be happy to port this wiki to an actual wiki, given enough support, but for the time being this is the best we can offer.
Usefull links:
MkDocs docs:
- https://mrkeo.github.io/setup/changing-the-colors/
- https://www.mkdocs.org/user-guide/configuration/#theme
- https://www.mkdocs.org/user-guide/choosing-your-theme/#mkdocs
- https://www.mkdocs.org/user-guide/configuration/#edit_uri
Color Encyclopedia: https://encycolorpedia.com/e6e6fa
Style Guide: https://bta.miraheze.org/wiki/Better_than_Adventure!_Wiki:Style_guide
Last Updated: