apache / apache/pulsar-client-cpp

[DOC] Create a dropdown version list for API document

Đang mở
#120 4 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation good first issue help wanted
Ngôn ngữ chính
C++
Star
71
Fork
90
Merge trung bình
2 giờ 33 phút
Pull request đã merge (30 ngày)
3

Mô tả

After a discussion with @momo-jun, I'm trying to add a version dropdown list in the C++ API documents so that we can always link to the latest version.

References:

* https://github.com/CGAL/cgal/blob/e1d4a96401e30cb2a3035e97c8bda44c15696cc9/Documentation/doc/Documentation/Doxyfile.in#L21
* https://docs.opencv.org/4.1.0
* https://doc.cgal.org/latest/Manual/packages.html

_Originally posted by @tisonkun in https://github.com/apache/pulsar/issues/18485#issuecomment-1316278706_

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

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

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra Documentation/doc/Documentation/Doxyfile.in và cấu trúc tài liệu API C++ được tạo. So sánh hành vi điều hướng phiên bản tại docs.opencv.org/4.1.0 và doc.cgal.org/latest/Manual/packages.html; công việc được xem là hoàn tất khi tài liệu API hiển thị một menu thả xuống phiên bản và liên kết đến phiên bản mới nhất của menu đó vẫn luôn được cập nhật.

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

Đánh giá

Công nghệ
cpp
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
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
35/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.