-
-
Notifications
You must be signed in to change notification settings - Fork 119
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
Improve Brigadier Documentation #507
base: main
Are you sure you want to change the base?
Conversation
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Co-authored-by: powercas_gamer <[email protected]>
Co-authored-by: powercas_gamer <[email protected]>
…24/paper-docs into improve-brigadier-docs
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.
You have both Art and Painting variant overview in the registry arguments page. Ideally names should be consistent either use bukkit name or the name in game.
docs/paper/dev/api/command-api/misc/comparison-bukkit-brigadier.mdx
Outdated
Show resolved
Hide resolved
For the command, I always use the registry name and for the name (the header) I use the backing object type. This is consistent with the other registries (E.g Music instrument). I can rename the headers to be consistent with the name of RegistryKey.XYZ and the in-game command though |
This PR aims to improve the documentation for Paper's new way of declaring commands using the Brigadier API.
Tip
I suppose this PR is now mergable. Not all content points have been included yet, but I will be declaring seperate PRs for those. This PR is big enough as-is
Roadmap:
Content
Examples(Separate PR)Custom Arguments(Separate PR)Common Issues(Separate PR)Quick reference(Separate PR)FAQ(Separate PR)Advanced (dispatcher and fork)(Separate PR)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 🚀