This repository has been archived by the owner on May 26, 2022. It is now read-only.
Add development documentation #62
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mple/development-documentation
|
It was suggested that we could maybe add some sort of styling "guidelines" for plugin configs, maybe that might be something to also add into this PR |
This is what I use internally and have collected / expanded on over the years, and I hope it's of some use to others. Maybe this could be used to get started, I am sure I am perhaps incorrect here and there, or am missing some important points. |
|
plan to work on this in the next few weeks when school is over for the winter |
|
Thanks so much for your initial work on this. Developer docs will be continued as part of our new documentation (PaperMC/docs#19) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a pretty big undertaking and help is welcomed, but I plan to keep cracking at it either way until it's good enough to go in.
So far, this is just some scaffolding with very little real content to go in. Input welcome for ideas of what to add.
This PR's goal is to eventually provide (at least a starting point for) a comprehensive user guide for development on Paper platforms (Paper/Waterfall). JavaDocs exist, and there are some guides floating around in sparse corners of the Internet, but a centralized location is probably better.
Draft for now, and potentially for a good amount of time still.
p.s. idk what to do about the merge commit :^) if someone wanna edumucate me feel free