Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better material table info #301

Open
masmc05 opened this issue Feb 5, 2024 · 0 comments
Open

Better material table info #301

masmc05 opened this issue Feb 5, 2024 · 0 comments

Comments

@masmc05
Copy link
Contributor

masmc05 commented Feb 5, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants