PaperMC / PaperMC/docs

Improve the userdev documentation

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

Nobody has claimed this yet.

dev guide meta guide project: Paper
Dominant language
MDX
Stars
73
Forks
280
Avg merge
20h 52m
Merged PRs (30d)
4

Description

I think userdev has grown big enough that it warrants more than just one page. It could also include all documentation currently "documented" in https://github.com/PaperMC/paperweight-test-plugin.

Another reason would be because the userdev page has a lot of asides, which should be split up/improved (https://github.com/PaperMC/docs/pull/681#issuecomment-3448010168)

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

Start by reviewing the current userdev documentation page and the documentation in the linked paperweight-test-plugin repository. Use the concerns in docs pull request 681, especially its comment, to identify asides that should be split or improved. Done means userdev is organized across more than one page and incorporates the relevant existing documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.