GDQuest / GDQuest/gdscript-docs-maker

Code a tool to update a JSON reference file

Abierto
#6 2 comentarios 0 reacciones 0 asignados Ver en GitHub
enhancement
Lenguaje dominante
Python
Estrellas
297
Forks
26
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

To make the docs maker as flexible as possible, we'd like to support having JSON keys or metadata on top of the one generated by the tool. That is to say, extra fields that may not be in the tool, like code examples, links to tutorials, references... extra information that would clutter the source code.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Comienza leyendo el flujo de generación de documentación del repositorio e identifica dónde se produce la referencia JSON. Determina cómo deben proporcionarse y conservarse los campos adicionales, como ejemplos de código, enlaces a tutoriales y referencias, y luego define los criterios de aceptación para actualizar la referencia generada sin sobrecargar el código fuente.

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

Evaluación

Stack tecnológico
python
Área
documentation, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.