apache / apache/pulsar-client-cpp

[DOC] Create a dropdown version list for API document

Abierto
#120 4 comentarios 0 reacciones 0 asignados Ver en GitHub
documentation good first issue help wanted
Lenguaje dominante
C++
Estrellas
71
Forks
90
Merge medio
2 h 33 min
PR fusionados (30 d)
3

Descripción

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_

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Empieza inspeccionando Documentation/doc/Documentation/Doxyfile.in y la estructura de la documentación de la API de C++ generada. Compara el comportamiento de navegación entre versiones en docs.opencv.org/4.1.0 y doc.cgal.org/latest/Manual/packages.html; se considera terminado cuando la documentación de la API expone un desplegable de versiones y su enlace a la versión más reciente se mantiene actualizado.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
cpp
Área
documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.