0xMiden / 0xMiden/docs

Improve documentation clarity

Đang mở
#327 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
TypeScript
Star
10
Fork
50
Merge trung bình
22 ngày 23 giờ
Pull request đã merge (30 ngày)
1

Mô tả

I found a small documentation improvement opportunity.

I would like to contribute a small documentation update to improve clarity and readability.

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

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

Hướng nghiên cứu

Issue không chỉ định phần nào của tài liệu cần cải thiện. Đầu tiên, hãy khám phá cấu trúc kho lưu trữ để hiểu bố cục tài liệu. Tìm kiếm các tệp markdown trong các thư mục phổ biến như 'docs/' hoặc 'src/'. Xác định các phần có thể mơ hồ hoặc khó đọc. Một điểm khởi đầu tốt là README.md hoặc bất kỳ hướng dẫn bắt đầu nào. Sau khi xác định được một khu vực cụ thể, hãy đề xuất một chỉnh sửa rõ ràng để cải thiện khả năng đọc.

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

Đánh giá

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

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.