Come up with plan for API documentation tooling
Abierto
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C++
- Estrellas
- 74
- Forks
- 9
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
We depend on documentation 4.0.0 as more recent releases removed `polygot` - refs documentationjs/documentation#850.
We either need to:
- [ ] Switch to a different tool
- [ ] Fix our usage of documentationjs to keep working with more recent versions
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza revisando la dependencia actual de documentation 4.0.0 y el issue #850 de documentationjs mencionado sobre la función polygot eliminada. Compara las dos opciones propuestas —cambiar de herramienta o corregir el uso para versiones más recientes— y define la finalización como una configuración documentada y funcional de la documentación de la API.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- cpp, node.js
- Área
- api, documentation, tooling
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100