PaperMC / PaperMC/docs

Improve Paper project creation page

Open
#697 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Every time I link the project setup guide, I have to recommend ignoring the mcdev part as that plugin serves little to no purpose for plugin development, the gradle build script it does some non-standard things in regard to setting the Java source/target compat and it generates plugins with paper-plugin.yml by default (which isn't as much of an issue as before, but they're still experimental so it being the default when everything else uses plugin.yml has been quite confusing for some users). Overall the whole MCDev part is rather redundant as it explains how to click the buttons in the wizard, which I don't believe is necessary for people who might want to use their generator as it should be plenty straight-forward.

[!NOTE]
The Minecraft development plugin templates have been updated to an extend that its usage can be recommended once again, which makes the above comment no longer an issue. Those changes are currently published on the nightly channel, but will makes its way onto the mainstream plugin release at some point.

There's also the simple fact that for this kind of guide which people will inevitably skim through, the fact that it shows two ways to achieve the project setup isn't immediately clear unless you're carefully reading the content. People expect some linearity in a guide like this.

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 at the Paper project creation page and review how the two setup paths are presented, including the MCDev guidance and the project template details mentioned in the issue. The work is done when the guide makes the alternatives and recommended linear path clear to readers who skim it.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.