apache / apache/pulsar-client-cpp
[DOC] Create a dropdown version list for API document
- Vorherrschende Sprache
- C++
- Sterne
- 71
- Forks
- 90
- Ø Merge
- 2 Std. 33 Min.
- Gemergte PRs (30 T.)
- 3
Beschreibung
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_
Beitragsleitfaden
Rechercherichtung
Beginne mit der Untersuchung von Documentation/doc/Documentation/Doxyfile.in und der Struktur der generierten C++-API-Dokumentation. Vergleiche das Verhalten der Versionsnavigation unter docs.opencv.org/4.1.0 und doc.cgal.org/latest/Manual/packages.html; abgeschlossen ist die Aufgabe, wenn die API-Dokumentation ein Versions-Dropdown bereitstellt und dessen Link zur neuesten Version aktuell bleibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100