apache / apache/pulsar-client-cpp
[DOC] Create a dropdown version list for API document
未关闭
documentation
good first issue
help wanted
- 主要语言
- C++
- 星标
- 71
- 派生
- 90
- 平均合并
- 2 小时 33 分钟
- 30 天内合并 PR
- 3
描述
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_
贡献指南
调研方向
首先检查 Documentation/doc/Documentation/Doxyfile.in 以及生成的 C++ API 文档结构。比较 docs.opencv.org/4.1.0 和 doc.cgal.org/latest/Manual/packages.html 中的版本导航行为；当 API 文档提供版本下拉菜单，并且其中指向最新版本的链接保持最新时，即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- cpp
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100