docs: add a README to @relkit/client

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#177 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 1 ngày

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
79/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
bun, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc WRITING.md và xem các tệp hiện có trong gói client để hiểu client có kiểu và cấu trúc tài liệu tham khảo API của nó. Thêm packages/client/README.md với phần giải thích ngắn, ví dụ api.orders.list và liên kết đến hướng dẫn về client trên relkit.dev. Chạy bun run check; công việc được xem là hoàn tất khi kiểm tra thành công và mọi ví dụ được thêm vào trang tài liệu đều vượt qua kiểm tra kiểu.

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

Mô tả

documentation good first issue

packages/client has no README.md, so its npm page is empty.

What to do

  • Add packages/client/README.md: what the typed client is, one short example of calling an API
    reference such as api.orders.list, and links to the client guide on https://relkit.dev.
  • Follow WRITING.md (plain language, one product name).

Done when bun run check passes and the example type-checks if you add it to a docs page too.

Ngôn ngữ chính
TypeScript
Star
1
Fork
0
Merge trung bình
2 giờ 45 phút
Pull request đã merge (30 ngày)
64

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 rel-kit/relkit

Tất cả issue của rel-kit/relkit

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.