A more coherent getting started pathway for Adventure
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
Description
Right now, users report that there isn't really a clear 'getting started' guide that provides an overview of how to dive into the API.
It would be nice to provide some sort of linear guide, targeting only native platforms, explaining how to:
- Create a component
- Send the component to a user
- Create a component from a configuration using MiniMessage
- maybe some other things?
How much of this can be done in our own docs without making too many assumptions about platforms? How much should be, we link to platforms for their dogumentation instead?
Migrated from https://github.com/KyoriPowered/adventure-docs/issues/150
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 by reviewing the existing Adventure API documentation and the native platform documentation to identify what belongs in a project-owned guide versus external links. Done means a linear getting-started pathway covers creating a component, sending it to a user, and creating one from a configuration with MiniMessage, while clearly handling platform-specific assumptions.
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
- 30/100