In-depth Component Guides
Open
Nobody has claimed this yet.
dev guide
help wanted
meta guide
project: Paper
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
Description
After https://github.com/PaperMC/docs/pull/145, there are more pages that should exist in the Component API category, diving into specific integrations between adventure and the paper api.
- [ ] Cover all adventure interfaces implemented by Paper API types
- [x] Demonstrate the use of AsyncChatEvent, specifically the ChatRenderer (#264)
- [ ] Demonstrate the use of SignedMessage
- [ ] Demonstrate resolving Components (`PaperComponents#resolveWithContext`)
- [ ] Demonstrate BookMetaBuilder
- [ ] Demonstrate click event callbacks
- [x] Add i18n docs (#194)
Contributor guide
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 with the existing Component API category and the documentation added by PaperMC/docs pull request 145. Review the unchecked topics in the task list, including SignedMessage, PaperComponents#resolveWithContext, BookMetaBuilder, and click event callbacks. Done means each remaining integration has a dedicated, usable guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100