Streamline and align the "Getting Started" docs to fit in the new structure

Đang mở
  • Có gì không ổn?
#1,415 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 3 ngày

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
csharp, unity
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với hướng dẫn Frontend Handbook được liên kết, sau đó kiểm kê tài liệu Getting Started của nền tảng sentry-unity và so sánh với cấu trúc mới. Công việc được xem là hoàn tất khi các hướng dẫn liên quan sử dụng các phần Install, Configure, Verify, Next Steps tùy chọn và Notes, tập trung vào onboarding cơ bản, cập nhật nội dung và snippet đã lỗi thời, đồng thời liên kết cấu hình nâng cao với sentry-docs.

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

Mô tả

Docs Unity
Problem Statement
  • The "Getting Started" documentation for sentry-unity platforms may not conform to the newly defined format, which includes the steps "Install", "Configure", "Verify", and the optional "Next Steps".
    • The "Verify" step is not always available and it is a very important step that helps the user to verify that the installation and configuration were done correctly.
  • New users onboarding with Sentry may find the existing documentation extensive and unclear. The "Getting Started" guide should cover the basics, while more advanced configurations shall live on the sentry-docs website.
  • Some copies and code snippets in the documentation may be outdated.
Solution Brainstorm

The task goals are as follows:

  • Thoroughly review all sentry-unity platform documentation, including less commonly used sections, and reorganize their content into structured headings: 'Install,' 'Configure,' 'Verify,' and the optional 'Next Steps.'
  • The onboarding documentation should strictly focus on the basics to help users get started. Advanced configurations should be available in the complete documentation on the sentry-docs website.
  • Essential information for new users should be included under the new 'Notes' section in the onboarding documentation.
  • Update code snippets and copies as necessary.
  • If a "Verify" step is missing, include it in the documentation.

Please refer to the "Frontendend Handbook" guide in our "Sentry" main repository for assistance in adding and updating the getting started docs: Frontendend Handbook.

Project: https://github.com/getsentry/team-sdks/issues/23

Ngôn ngữ chính
C#
Star
294
Fork
63
Merge trung bình
3 ngày 17 giờ
Pull request đã merge (30 ngày)
26

Chuẩn bị môi trường

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 getsentry/sentry-unity

Tất cả issue của getsentry/sentry-unity

Issue tương tự

Thêm issue về C#

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.