A more coherent getting started pathway for Adventure

未关闭
#666 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
30/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
停滞
领域
documentation

调研方向

首先查看现有的 Adventure API 文档和原生平台文档,以确定哪些内容应属于项目自有指南,哪些内容应通过外部链接提供。完成标准是:一条线性的入门路径涵盖创建组件、将其发送给用户,以及使用 MiniMessage 从配置创建组件,同时明确处理特定于平台的假设。

由索引模型根据 Issue 内容生成。

描述

dev guide good first issue project: Adventure

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

主要语言
MDX
星标
73
派生
280
平均合并
16 小时 42 分钟
30 天内合并 PR
5

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

PaperMC/docs 的其他 Issue

查看 PaperMC/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。