apache / apache/pulsar-client-cpp

[DOC] Create a dropdown version list for API document

Aperta
#120 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub
documentation good first issue help wanted
Lingua principale
C++
Stelle
71
Fork
90
Merge medio
2h 33m
PR unite (30g)
3

Descrizione

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_

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando Documentation/doc/Documentation/Doxyfile.in e la struttura della documentazione API C++ generata. Confronta il comportamento della navigazione tra le versioni su docs.opencv.org/4.1.0 e doc.cgal.org/latest/Manual/packages.html; il lavoro è completato quando la documentazione API espone un menu a discesa delle versioni e il relativo collegamento alla versione più recente rimane aggiornato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.