PrismarineJS / PrismarineJS/minecraft-data
Make the docgen of the protocol only about types, not packets
Open
Nobody has claimed this yet.
documentation
protocol
- Dominant language
- JavaScript
- Stars
- 938
- Forks
- 294
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 25
Description
I think it should just display types, recursively if needed.
Trying to flatten stuff make it really complicated.
Especially relevant now that the packet concept is off the protocol.json thanks to #122
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the JavaScript docgen entry point and inspect how it reads protocol.json. Review issue #122 for the packet removal context. Done means generated protocol documentation displays types recursively where needed and no longer attempts to flatten or document packets.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100