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

Grimoire docs need examples

Đang mở Phù hợp với người mới
#803 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách tìm tài liệu tham chiếu API của module trong Resyntax Grimoire và so sánh chúng với các phần tài liệu Resyntax khác đã sử dụng @examples. Thêm các ví dụ phù hợp vào những tài liệu tham chiếu API liên quan, sau đó xác minh rằng mỗi phần tài liệu đã thay đổi được render và thể hiện API của nó đúng như dự kiến.

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

Mô tả

documentation

The various module API reference docs in the Resyntax Grimoire don't use @examples anywhere. They should, like the other sections of the Resyntax docs do.

Ngôn ngữ chính
Racket
Star
70
Fork
11
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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 jackfirth/resyntax

Tất cả issue của jackfirth/resyntax

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.