PaperMC / PaperMC/docs

Better material table info

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

Nobody has claimed this yet.

blocked by feature for-future help wanted
Dominant language
MDX
Stars
73
Forks
280
Avg merge
20h 52m
Merged PRs (30d)
4

Description

Material javadoc isn't really user friendly, including the fact that it still has legacy materials which confuses new people

This would be a good addition to https://docs.papermc.io/paper/cat/admin/reference

The general idea is to make an alternative solution which is more user friendly than something made as a code documentation

My idea on how this could be done is a table

  • The table has a mode at the top where the user can select between "all materials", "items" and "blocks". The selection should reflect in the link so it could be easily shareable, should be useful for plugin developers to share in documentation for users with a preselected link. This is to prevent people from accidentally putting POTATOES instead of POTATO in a list of items in configs
  • The ability to filter materials based on vanilla tags
  • Columns which aren't appropriate with the mode are hidden (like item meta for block mode)
  • It would be good to have those columns

Of course this is just a suggestion and anything would be better than java docs

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 with the Paper admin reference page and the linked Material and Registry Javadocs to map the existing information and identify the documentation structure. Done means a user-friendly, shareable material table covering the proposed modes, filters, relevant columns, and legacy-material guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.