Allow pinning certain sections in documentation
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ính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- ruby
- Lĩnh vực
- documentation, frontend
Hướng nghiên cứu
Bắt đầu bằng việc xem lại tầm nhìn của DevDocs trong README.md, sau đó kiểm tra cách các phần tài liệu hiện được trình bày trong những bộ như C++ và CSS. Làm rõ cách các phần được ghim được lưu trữ theo từng bộ tài liệu và thứ tự nên hoạt động như thế nào; công việc được xem là hoàn thành khi người dùng có thể ghim một phần và thấy phần đó ở đầu các trang tương ứng mà không ảnh hưởng đến các bộ tài liệu khác.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Feature request
Summary
In documentations a lot of times there are sections that consistently exist across most pages of the docs, for instance in the C++ documentation a lot of times you find that there is an Examples section that shows how to use the function being documented. I would really like to have the example section appear on the top of the page because a lot of times it does a much better job at explaining what the function does and how to use it than the cppreference cryptic definitions.
Examples
I don't have a screenshot of this feature from another source. I think having a pin button next to the sections is a good starting point. When that button is clicked, the section should be added to a list of pinned sections, and whenever the visited page contains that section, it should be displayed at the top of the page. Of course, the pinned sections will be local to each set of docs, so if you pin the Examples section in the C++ docs, it won't be pinned in the CSS docs. This is both simpler to implement and makes sense, since each documentation set has its own structure.
I think this is a solid foundation to build on. From there, you could refine it further, perhaps by adding a settings section in each set of docs where you can view all available sections in those docs and allow the user to drag and drop them into a list to define their preferred order. However, this would 1) be quite challenging to implement and 2) may not be practical in reality.
- Ngôn ngữ chính
- Ruby
- Star
- 39.5k
- Fork
- 2.6k
- Merge trung bình
- 2 ngày 9 giờ
- Pull request đã merge (30 ngày)
- 13
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của freeCodeCamp/devdocs
-
class Data in Ruby 3.2 Đang mởdocs/improvement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
freeCodeCamp/devdocs#1989 · 4 bình luận · 4 reaction ·
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
freeCodeCamp/devdocs#2731 ·
-
feature
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
freeCodeCamp/devdocs#2712 ·
-
feature
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 30/100
freeCodeCamp/devdocs#2683 · 1 bình luận ·
-
Unit test frontend code Đang mởfeature
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
freeCodeCamp/devdocs#2673 ·
Tất cả issue của freeCodeCamp/devdocs
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Please Drop ruby 3.2 support Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
googleapis/google-api-ruby-client#28001 · 5 reaction ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100