Skip to content
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
wants to merge 55 commits into
base: main
Choose a base branch
from

Conversation

Strokkur424
Copy link
Contributor

@Strokkur424 Strokkur424 commented Dec 14, 2024

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

  • Add Bukkit <-> Paper command comparison
  • Introduction page
  • Command Tree Structure
  • Arguments and Literals
  • The executes method
  • The requires method
  • Native Arguments (StringArgumentType, IntegerArgumentType, etc)
  • Registering Brigadier Commands
  • BasicCommand
  • Minecraft Arguments
  • Registry Arguments (The current arguments page)
  • Examples
  • Common Issues (mainly incorrect braces)
  • Quick reference
  • FAQ

Finalization

  • Add JavaDocs links where ever possible
  • Final revision (Mergable)

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:

  1. Start a code review and just highlight any issues you see with the current state of things. I will try my best to improve on those issues.
  2. Open a PR to my fork/branch. This would make sense for new pages, but for editing existing pages, unless the change is big, I would prefer the first option.

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 🚀

@Strokkur424 Strokkur424 marked this pull request as draft December 14, 2024 11:15
Copy link

github-actions bot commented Dec 14, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
papermc-docs ✅ Ready (View Log) Visit Preview d5441c7

…sage, style, templatemirror/rotation, time, uuid, and world arguments
Merge pull request #1 from Strokkur424/main
Copy link
Member

@olijeffers0n olijeffers0n left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants