[Brigadier] Quick reference
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
Description
[!NOTE]
This issue is part of a series of issues regarding the extension of the Paper documentation regarding Paper's Brigadier API.
I feel like it'd be great for returning users to have a very simple and quick reference they can use to refresh their knowledge on certain aspects.
For example, there could be a section called "permission declaration" which quickly repeats that one can use the requires method to check the sender's permission in order to execute and view a command or argument.
Possible aspects referenced could be:
- Argument declaration
- Argument retrieval
- Permission declaration
- Difference sender and executor
- Custom argument suggestions
- Custom arguments
- Registering commands
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing Paper documentation for the Brigadier API and compare it with the proposed topics: argument declaration and retrieval, permissions, sender versus executor, suggestions, custom arguments, and command registration. Done means adding a concise quick-reference section covering the agreed aspects; the issue does not name a specific file or test.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100