-
-
Notifications
You must be signed in to change notification settings - Fork 118
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.
The docs are really good. Couple of nitpicks that i saw though.
I am concerned about the video file size a little bit. One is 20MB. These could be compressed potentially but unsure if this is the best route to take. I know this was discussed in the past
I haven't been made aware of any such discussions. If you wish, I can reduce the file sizes a bit |
I reduced the file sizes very drastically whilst still keeping it somewhat high-quality. Hopefully that should be enough? |
docs/paper/dev/api/command-api/arguments/adventure-arguments.mdx
Outdated
Show resolved
Hide resolved
docs/paper/dev/api/command-api/arguments/adventure-arguments.mdx
Outdated
Show resolved
Hide resolved
docs/paper/dev/api/command-api/arguments/adventure-arguments.mdx
Outdated
Show resolved
Hide resolved
docs/paper/dev/api/command-api/arguments/adventure-arguments.mdx
Outdated
Show resolved
Hide resolved
docs/paper/dev/api/command-api/arguments/adventure-arguments.mdx
Outdated
Show resolved
Hide resolved
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.
needs a redirect to not kill existing links
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.
needs a redirect to not kill existing links
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Pretty sure I just had that temporarily in whilst writing. My bad Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Matouš Kučera <[email protected]>
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 🚀