[mkdocs] - rebuild docs automatically on update
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- JavaScript
- Estrellas
- 18.3k
- Forks
- 2k
- Merge medio
- 2 d 12 h
- PR fusionados (30 d)
- 28
Descripción
One of the benefits of our current docs for contributors if you are working on a doc and make some change to an example or some text, jekyll rebuilds the documentation automatically and you can see the change in your browser.
With how mkdocs is implemented on the live-docs branch you need to stop the mkdocs server, rebuild the docs using make examples and then restart the server (mkdocs serve)
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza en la rama live-docs revisando cómo se usan actualmente make examples y mkdocs serve. Rastrea el flujo de reconstrucción de la documentación y compáralo con el comportamiento descrito de Jekyll; se considera terminado cuando los cambios en los ejemplos o en el texto aparecen en el navegador sin tener que detener, reconstruir y reiniciar manualmente el servidor.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- build-system, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100