PaperMC / PaperMC/docs

More adventure pointer docs

Open
#664 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

It would be nice to split pointer docs into it's own page(s) with the following aspects:

  • Usage of the API
  • Standard, Adventure-provided pointers
  • Community additions (if any, open for additions for platforms/etc) - is this even something we should encourage?

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

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 files or tests are named. Start by locating the existing pointer documentation and reviewing how related Adventure pages are organized; then define separate page(s) covering API usage, standard Adventure pointers, and any community additions. Done means the pointer material is split into its own documented structure and the question of encouraging community additions is resolved.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.