ProjectTech4DevAI / ProjectTech4DevAI/kaapi-backend
API Documentation: Platform acquisition and migration
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 18
- Forks
- 10
- Merge medio
- 2 d 20 h
- PR fusionados (30 d)
- 14
Descripción
Is your feature request related to a problem?
We lack a dedicated API documentation platform. This hinders clear communication and understanding of our APIs, leading to confusion among users.
Describe the solution you'd like
- Acquire a suitable API documentation platform.
- Migrate existing documentation to the new platform.
Original issue
Get a API docs platform and migrate.
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 haciendo un inventario de la documentación existente de la API y definiendo los requisitos para una plataforma de documentación dedicada. Evalúa las plataformas adecuadas con los maintainers y, después, planifica el alcance de la migración. Se considerará terminado cuando se haya seleccionado una plataforma y se haya migrado a ella la documentación existente de la API.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- api, documentation
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Tranquilo
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 30/100