freeCodeCamp / freeCodeCamp/devdocs

Add support to include links to the source code if available

Đang mở
#763 2 bình luận 4 reaction 0 người được giao Xem trên GitHub
docs/improvement
Ngôn ngữ chính
Ruby
Star
39.5k
Fork
2.6k
Merge trung bình
4 ngày 32 phút
Pull request đã merge (30 ngày)
13

Mô tả

Using the Nim documentation as an example, check out [this](https://nim-lang.org/docs/threads.html) link.

You can see that every method, variable or constant has a link directly to the source code in github.com. This makes it very easy to look at the actual implementation.

Other random languages I just checked. These also have such links handy.

[Crystal](https://crystal-lang.org/api/0.24.1/Tuple.html)
[Elixir](https://hexdocs.pm/elixir/Atom.html)
[Rust](https://doc.rust-lang.org/std/primitive.char.html)

Having access to the implementation by link in devdocs will make it super useful. Without it, I end up using the language docs even though devdocs is much cooler.

As an aside, I see you have a link to the original doc page that was scraped at the bottom so in theory I could click on that, find the function again and then click there. But most docs also have a permalink to each entry. It would be beneficial to include this permalink within devdocs as well so you could jump to the official documentation from right there.

Ideally, we have both these links handy within devdocs so there's no reason to go to the official docs.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Không có tệp, bài kiểm thử hoặc điểm vào nào được nêu tên. Hãy so sánh tài liệu được liên kết của Nim, Crystal, Elixir và Rust để xác định các permalink đến mã nguồn và tài liệu chính thức được cung cấp như thế nào, sau đó lần theo nơi DevDocs có thể lưu giữ và hiển thị cả hai liên kết; được xem là hoàn thành khi cả hai liên kết xuất hiện nếu có, mà không xóa liên kết hiện có đến trang gốc.

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
developer-experience, 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
Khá rõ ràng
Mức phù hợp với người mới
25/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.