PaperMC / PaperMC/docs

Add Permissions API docs

Open
#647 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
73
Forks
280
Avg merge
20h 52m
Merged PRs (30d)
4

Description

Not sure if people even need a Permissions documentation, but since there are multiple ways to manage your plugin's permission I thought it could be useful to know what way could suit you needs best. Also a brief explanation on how permissions are handled on the server side could be nice.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named; first locate the existing permissions documentation and the relevant server-side permissions material in the docs. Document the available ways to manage a plugin's permissions, explain how they differ, and add a brief explanation of server-side handling.

Written by the indexing model from the issue text.

Assessment

Domain
authorization, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.