Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

configure jsdoc environment #11

Open
2 tasks
carloslenondavis opened this issue Mar 30, 2020 · 3 comments
Open
2 tasks

configure jsdoc environment #11

carloslenondavis opened this issue Mar 30, 2020 · 3 comments
Labels
code-structure documentation Improvements or additions to documentation enhancement New feature or request high-priority

Comments

@carloslenondavis
Copy link

  • configure jsdoc config files for connotation,
  • config server file to lift documentation site
@carloslenondavis carloslenondavis self-assigned this Mar 30, 2020
@carloslenondavis carloslenondavis added code-structure documentation Improvements or additions to documentation enhancement New feature or request high-priority labels Mar 30, 2020
@hosmelq
Copy link
Member

hosmelq commented Mar 30, 2020 •
edited
Loading

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

@carloslenondavis
Copy link
Author

carloslenondavis commented Mar 30, 2020 •
edited
Loading

@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
Copy link
Author

Para la version en prod usaremos docusaurus

@carloslenondavis carloslenondavis removed their assignment Jul 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code-structure documentation Improvements or additions to documentation enhancement New feature or request high-priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hosmelq @carloslenondavis