PaperMC / PaperMC/docs

Document adventure-nbt

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

Nobody has claimed this yet.

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

Description

There's currently nothing on adventure-nbt, so everything needs to be covered

Key points

  • Immutability
  • Serializing to binary format
  • Working with string format -- in its various iterations

Migrated from https://github.com/KyoriPowered/adventure-docs/issues/9

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

No documentation file, test, or entry point is named in the issue. Start by locating the existing documentation structure and any adventure-nbt references, then determine how the immutability, binary serialization, and string-format topics fit together. Done means adventure-nbt has complete coverage of those areas.

Written by the indexing model from the issue text.

Assessment

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.