API Documentation: Platform acquisition and migration

Abierto
#1,132 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
30/100
Tipo de issue
Documentación
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Área
api, documentation

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.

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.

Lenguaje dominante
Python
Estrellas
18
Forks
10
Merge medio
2 d 20 h
PR fusionados (30 d)
14

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ProjectTech4DevAI/kaapi-backend

Todos los issues de ProjectTech4DevAI/kaapi-backend

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.