A more coherent getting started pathway for Adventure

Đang mở
#666 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
30/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem lại tài liệu Adventure API hiện có và tài liệu của nền tảng gốc để xác định nội dung nào thuộc về hướng dẫn do dự án sở hữu và nội dung nào nên được dẫn đến bằng các liên kết bên ngoài. Công việc được xem là hoàn tất khi một lộ trình bắt đầu tuyến tính bao quát việc tạo một component, gửi component đó cho một người dùng và tạo một component từ cấu hình bằng MiniMessage, đồng thời xử lý rõ ràng các giả định dành riêng cho nền tảng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
MDX
Star
73
Fork
280
Merge trung bình
16 giờ 42 phút
Pull request đã merge (30 ngày)
5

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của PaperMC/docs

Tất cả issue của PaperMC/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.