apache / apache/pulsar-client-cpp
[DOC] Create a dropdown version list for API document
- 主要言語
- C++
- スター
- 71
- フォーク
- 90
- 平均マージ
- 2時間 33分
- マージ済み PR(30日)
- 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