A more coherent getting started pathway for Adventure

オープン
#666 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
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分
マージ済み PR(30日)
5

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

PaperMC/docs のほかの issue

PaperMC/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。