configure jsdoc environment

[carloslenondavis]

• [ ] configure jsdoc config files for connotation,
• [ ] config server file to lift documentation site

[hosmelq]

Que documentación habrá que es necesario un sito?

[carloslenondavis]

@hosmelq, analizando tu pregunta, aun no estoy claro de tu duda.

No obstante, existen muchos niveles de documentación de código entre las mas usadas la restringida por el ruler de codigo documentación de secciones componentes archivos .

Usando un generador se obtiene la descripción de tu código, y la estructuración del mismo. Hay muchos beneficios sobre el documentar el código, ente los que me ha beneficiado

• Facilidad en el rampup de un miembro nuevo
• Intellisense Editor o IDE
• Información al momento del mantenimiento del código
• API de tu code
• etc..

Como este proyecto es de caracter opensource, es importante el apoyo del lado del developer, para pueda entender de forma mas rápida la estructura del código, mas cuando no tiene mucha experiencia.

[carloslenondavis]

Para la version en prod usaremos docusaurus