apache / apache/pulsar-client-cpp

[DOC] Create a dropdown version list for API document

Ouverte
#120 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
documentation good first issue help wanted
Langage dominant
C++
Étoiles
71
Forks
90
Merge moyen
2 h 33 min
PR mergées (30 j)
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_

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par examiner Documentation/doc/Documentation/Doxyfile.in et la structure de la documentation d’API C++ générée. Comparez le comportement de navigation entre les versions sur docs.opencv.org/4.1.0 et doc.cgal.org/latest/Manual/packages.html ; le travail est terminé lorsque la documentation d’API expose une liste déroulante des versions et que son lien vers la version la plus récente reste à jour.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
cpp
Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.