Laboratoria / curriculum

El bootcamp de @Laboratoria es un programa de aprendizaje inmersivo de 6 meses enfocado en los perfiles de Web Developer y UX Designer.
https://curriculum.laboratoria.la
Creative Commons Attribution Share Alike 4.0 International
491 stars 462 forks source link

Desplegar un sitio de documentacion en gh-pages cuando creamos nuevo proyecto #1414

Closed unjust closed 1 month ago

unjust commented 1 year ago

Problema: Cuando agregamos contenido al READMEs y documentacion de los proyectos, puede ser mas dificil a navegar/leerlo para las estudiantes. No es muy user-friendly.

Solucion: Desplegamos un sitio de documentaction con cada proyecto , usando una herramienta como https://docusaurus.io/

Seria bueno experimentar con eso, quiza con un flag --experimental o --createDocs hasta que estamos seguro que es una mejora. Podemos lanzar eso con este PR por ejemplo #1375 .

Ejemplo crudo https://comun-radio.github.io/DEV106-burger-queen-api/


Update:

En lugar de automatizar algo experimaental al principio, podemos hacer un prueba manual con markdown links usando la idea de @Davichobits

unjust commented 1 year ago

Mejor ejemplo, pero aun manual https://davichobits.github.io/demo-mdlinks/ Pensamos podemos hacer algo manualmente para probar con el primer cohort con un MVP rapido, y de ahi si queremos quedar con eso, hacerlo automatizado.

Algunas configuraciones que podemos agregar a tu demo @Davichobits:

 { 
    baseUrl: repoName,
    projectName: repoName,
    organizationName: 'Laboratoria',
  };

He revisado como hacerlo y puedo ayudar!

Davichobits commented 1 year ago

Para que el proyecto esté dentro de Laboratoria, debería crear un nuevo proyecto dentro de bootcamp?