Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Review documentation examples and content

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

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

@Convexkarma đang làm issue này rồi.

Từ ngày 28/2/2026.

  • #164 của @Convexkarma — đang mở

Đá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
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
documentation, testing

Hướng nghiên cứu

Xem xét các tệp .mdx trong các phần docs/content/docs/ được liệt kê, bỏ qua các mục được đánh dấu là Coming soon, WIP hoặc incomplete. Chạy các ví dụ có thể chạy cục bộ bằng npx tsx test.ts và đánh dấu các ví dụ phụ thuộc vào mạng hoặc wallet là Skip. Báo cáo kết quả của từng ví dụ và cung cấp phần làm rõ, các vấn đề cùng đề xuất theo định dạng được chỉ định.

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

Mô tả

documentation

Task: Review Documentation Examples and Content

Goal: Test all code examples and provide feedback on documentation clarity and completeness.

Files to Review
Section Path
Getting Started docs/content/docs/introduction/
Clients docs/content/docs/clients/
Wallets docs/content/docs/wallets/
Transactions docs/content/docs/transactions/
Smart Contracts docs/content/docs/smart-contracts/
Addresses docs/content/docs/addresses/
Assets docs/content/docs/assets/
Staking docs/content/docs/staking/
Governance docs/content/docs/governance/
Querying docs/content/docs/querying/
Encoding docs/content/docs/encoding/
Time docs/content/docs/time/
Devnet docs/content/docs/devnet/
Instructions
  1. Open each `.mdx` file in the section
  2. Skip any that say "Coming soon", "WIP", or are clearly incomplete
  3. For each code example:
    • If it can run locally: run it with `npx tsx test.ts` and report pass or fail
    • If it needs network/wallet: mark as Skip
  4. For the text content, provide feedback on:
    • Is the description clear and accurate?
    • Would a beginner understand it?
    • Are there confusing parts or missing context?
    • Any suggestions for improvement?
Report Format

```

docs/content/docs/wallets/index.mdx

Examples
  • Example 1 (line 23): Pass
  • Example 2 (line 45): Fail - "Property 'x' does not exist"
  • Example 3 (line 67): Skip - needs funded wallet
Content Feedback
  • Clear: Yes / Mostly / No
  • Issues: List any problems found
  • Suggestions: List any improvements
    ```
Ngôn ngữ chính
TypeScript
Star
22
Fork
33
Merge trung bình
2 ngày 1 giờ
Pull request đã merge (30 ngày)
44

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 IntersectMBO/evolution-sdk

Tất cả issue của IntersectMBO/evolution-sdk

Issue tương tự

Thêm issue về TypeScript

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.