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

Add hosted docs

Đang mở
  • Có gì không ổn?
#548 2 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Trước tiên, hãy xem xét tài liệu VRS-Python hiện có và các ví dụ Read the Docs được liên kết. Xác định riêng nội dung dành cho đối tượng phổ thông và nhà phát triển cho trang web được lưu trữ, sau đó xác minh rằng tài liệu tạo ra có thể truy cập tại địa chỉ được đề xuất vrs-python.readthedocs.io và bao quát cả hai đối tượng.

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

Mô tả

documentation priority:high
Feature description

Add hosted HTML docs (on RTD) for technical and general-audience documentation

Use case

Documentation will help both users and developers understand VRS-Python better

Acceptance Criteria

Given I'm a non-technical user,
When I go to vrs-python.readthedocs.io (or something similar),
Then I should see documentation on general info about VRS-Python (I like Beacon's general docs as an example: https://genomebeacons.org/)

Given I'm a developer,
When I go to vrs-python.readthedocs.io (or something similar),
Then I should see technical documentation about VRS-Python (I like Beacon's general docs as an example: https://docs.genomebeacons.org/)

Proposed solution

No response

Alternatives considered

No response

Implementation details

No response

Potential Impact

No response

Additional context

More good examples that @jsstevenson created for some of our projects:

Contribution

None

Ngôn ngữ chính
Python
Star
64
Fork
44
Merge trung bình
3 ngày 2 giờ
Pull request đã merge (30 ngày)
6

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có 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 ga4gh/vrs-python

Tất cả issue của ga4gh/vrs-python

Issue tương tự

Thêm issue về Python

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.