void-linux / void-linux/void-docs

Single-page version of Handbook?

Đang mở
#243 8 bình luận 3 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

enhancement help wanted
Ngôn ngữ chính
CSS
Star
217
Fork
212
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
1

Mô tả

Can/should we provide a single-page version of the Handbook? A user on IRC asked if there was one, and it seems to me that it would make it easier for users to search for particular terms within the Handbook.

Related: the above user noted that it was annoying to go to a page in the Handbook and find that it contained only a brief overview of the section. In a single-page version, i imagine this would be fine; but if we started adding ToCs for subsections (cf. https://github.com/void-linux/void-docs/pull/234), that might end up being unwieldy in a single-page version.

@ericonr, @bobertlo, thoughts?

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.

Hướng nghiên cứu

Xem xét mã nguồn của Handbook và cách tiếp cận mục lục cho các tiểu mục được thảo luận trong PR #234. Quyết định liệu có mong muốn một Handbook trên một trang hay không và cách phần điều hướng của nó nên xử lý nội dung các tiểu mục; được xem là hoàn tất khi phạm vi và định dạng đầu ra đã được thống nhất trước khi triển khai.

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ính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
20/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.