nodejs / nodejs/doc-kit

Support mermaid diagrams

Abierto
#892 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
JavaScript
Estrellas
65
Forks
71
Merge medio
2 d 17 h
PR fusionados (30 d)
31

Descripción

Enter your suggestions in details:

When exploring doc-kit docs within https://github.com/nodejs/doc-kit/pull/889, I was going to render the parsing pipeline as a simple mermaid diagram instead of the codeblock ascii.
I think it would be a reasonable expectation for a generic tool like this, in 2026, to support mermaid diagram rendering.

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.

Línea de trabajo

Comienza leyendo el contexto de la documentación de doc-kit y el pull request #889, donde se analiza el diagrama de la canalización de análisis. Identifica cómo se renderizan actualmente los bloques de código de la documentación y determina la entrada de Mermaid compatible y la ruta de renderizado. Se considera completado cuando los diagramas de Mermaid se renderizan correctamente en la documentación relevante sin romper la salida existente de los bloques de código.

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

Evaluación

Stack tecnológico
javascript
Área
documentation
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Tranquilo
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.