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

Document more Web3 gateway options

Đang mở
#863 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
58/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ệ
go
Lĩnh vực
blockchain, documentation

Hướng nghiên cứu

Cập nhật docs/node/web3.mdx, sử dụng các tùy chọn được tham chiếu trong oasis-web3-gateway/conf/config.go làm nguồn. Trước tiên, hãy so sánh cấu trúc các phần với các chương khác về Oasis node và xem xét giá trị mặc định cũng như ngữ cảnh của từng tùy chọn. Công việc được xem là hoàn tất khi trang có một phần Configuration, các phần con Archive Web3 gateway và Pruning, đồng thời tài liệu hóa chính xác các cài đặt gateway liên quan còn lại.

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

Mô tả

documentation

Rename "Running the Web3 gateway" section in https://github.com/oasisprotocol/docs/blob/main/docs/node/web3.mdx to "Configuration" so it's consistent with other Oasis node chapters. Then:

  • Make "Archive Web3 gateway" a subsection.
  • Move the pruning-related settings out of the default config to a "Pruning" subsection.
  • Document other relevant Web3 gateway options in the corresponding subsections (be conscious about the default values and their context).
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.