apache / apache/pulsar-client-cpp
[DOC] Create a dropdown version list for API document
- Dominant language
- C++
- Stars
- 71
- Forks
- 90
- Avg merge
- 2h 33m
- Merged PRs (30d)
- 3
Description
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_
Contributor guide
Research direction
Start by inspecting Documentation/doc/Documentation/Doxyfile.in and the generated C++ API documentation structure. Compare the version-navigation behavior at docs.opencv.org/4.1.0 and doc.cgal.org/latest/Manual/packages.html; done means the API documentation exposes a version dropdown and its latest-version link remains current.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100