Consider recommending great-docs for documentation module
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Tranquilo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Empieza por localizar la sección del módulo de documentación que actualmente cubre MkDocs; después, lee la documentación y el repositorio de great-docs enlazados. Compara su requisito de Python 3.11+ y su flujo de trabajo basado en Quarto con la configuración del curso. Se considera terminado cuando la evaluación incluye una conclusión documentada sobre si se debería recomendar o añadir great-docs.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The documentation module currently covers MkDocs. great-docs from Posit is a new Python documentation site generator worth evaluating as an alternative or addition.
Why it's interesting for this course
- Built on Quarto — same toolchain the course already uses for slides
- Zero-config API reference — auto-discovers public API from docstrings (NumPy, Google, Sphinx formats)
- Minimal setup —
great-docs init/build/preview, no templates or manual page authoring needed - Modern defaults — dark mode, responsive, sidebar search, GitHub integration
- AI-ready — generates
llms.txtfiles
Links
- Documentation
- GitHub
- PyPI (requires Python 3.11+)
- Lenguaje dominante
- Jupyter Notebook
- Estrellas
- 8
- Forks
- 1
- Merge medio
- 4 min
- PR fusionados (30 d)
- 1
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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.
Más de DHI/python-package-development
-
Dificultad 2/5 1-2 días Aptitud para principiantes 88/100
-
Dificultad 2/5 1-2 días Aptitud para principiantes 72/100
DHI/python-package-development#37 · 1 comentario ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 48/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
Todos los issues de DHI/python-package-development
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
agilepathway/label-checker#640 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
BasedHardware/omi#15662 · 1 comentario ·
-
documentation help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 90/100
-
Docs are out of date: README structure tree, "Make It Yours" pointer, CONTRIBUTING test notes Abiertodocumentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
Kong/developer.konghq.com#7316 ·