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

Manually curate page descriptions for pages linked as doc cards

Đang mở
#181 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
38/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ệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách xem xét hành vi mô tả trang được giới thiệu trong issue #180 và xác định các trang Markdown được dùng làm thẻ tài liệu. Thay thế các mô tả được suy ra tự động nhưng không phù hợp bằng các mô tả được biên soạn thủ công, chẳng hạn như ví dụ ROSE-to-EVM, sau đó xác minh rằng các thẻ bị ảnh hưởng hiển thị đúng văn bản dự kiến.

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

Mô tả

After #180, Markdown page descriptions are generated automatically by taking the first conten-ful line.

Since we are using 80-character line wrapping and we start the guides with introductory "This guide will teach you ...", this doesn't work so well.

An example:
Screenshot from 2022-07-26 23-29-07

A better manually curated description would be something like:

Guide on transferring ROSE tokens from consensus into EVM-compatible ParaTimes

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

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 oasisprotocol/docs

Tất cả issue của oasisprotocol/docs

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.