-
-
Notifications
You must be signed in to change notification settings - Fork 114
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
[WIP] Improve Brigadier Documentation #507
Draft
Strokkur424
wants to merge
55
commits into
PaperMC:main
Choose a base branch
from
Strokkur424:improve-brigadier-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
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
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
powercasgamer
suggested changes
Dec 14, 2024
Co-authored-by: powercas_gamer <[email protected]>
Co-authored-by: powercas_gamer <[email protected]>
…24/paper-docs into improve-brigadier-docs
…sage, style, templatemirror/rotation, time, uuid, and world arguments
Merge pull request #1 from Strokkur424/main
powercasgamer
suggested changes
Dec 21, 2024
docs/paper/dev/api/command-api/arguments/adventure-arguments.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: powercas_gamer <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, I like these docs a lot. They are very in-depth and offer sufficient examples to allow users to understand them.
Some of the pages can get quite text rich, however most is necessary.
docs/paper/dev/api/command-api/misc/comparison-bukkit-brigadier.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Ollie <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 aims to improve the documentation for Paper's new way of declaring commands using the Brigadier API.
Warning
Do not merge this PR yet, as it is incomplete. You can check out the current state of things below:
Roadmap:
Content
Finalization
Reasons for opening a PR:
I wanted to open this PR so that other people could check out the current state of things and help me improve (and potentially even correct me on) the documentation I am writing. I want to make sure that everybody, beginner or advanced, can understand everything written here with ease, because the Brigadier system is less scary than it sounds, yet it is not well documented.
If you want to help contribute:
There is two ways you can help me with this PR:
If you have any suggestions...
...please do not hesitate to comment on this PR. I will take all suggestions into consideration.
Let's make the docs even better 🚀