Consider moving to MkDocs
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 20/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- markdown
- Área
- documentation
Línea de trabajo
Revisa la configuración actual de Sphinx y la documentación existente en Markdown y reST; después, compara las extensiones personalizadas con MkDocs y su tema Material. Comprueba la configuración existente de Lychee para verificar enlaces y la viabilidad de una conversión gradual a Markdown. El issue no especifica archivos ni criterios de aceptación, por lo que todavía hay que acordar el alcance de la migración y la definición de terminado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Just an idea. Pros:
- Simpler stack, simpler config.
- Markdown has won. People don't know reST, even myself, after years of using it, still make the most basic mistakes and need to lookup the most basic stuff.
- Also supported by RTD.
- Has the Material theme, which is modern, under active development, flexible, has dark theme, etc.
- Is used at other projects, such as python.cz or junior.guru, so know-how would be shared (contributions, maintenance).
Cons:
- We extend Sphinx and would need to rewrite those things.
- We use reST extensively. I'm not sure we can port it 1:1 (but is it necessary?)
How:
- This can happen gradually. Our current setup supports Markdown, so texts can be converted first and we would see.
- I already moved from builtin Sphinx link check to Lychee, as it works better.
- Lenguaje dominante
- Python
- Estrellas
- 13
- Forks
- 18
- Merge medio
- 2 h 11 min
- PR fusionados (30 d)
- 6
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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.
Más de pyvec/docs.pyvec.org
-
Info o PayPal a WiseAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
pyvec/docs.pyvec.org#537 ·
-
Navod pro prednasejici novackyAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
pyvec/docs.pyvec.org#30 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 25/100
pyvec/docs.pyvec.org#538 ·
-
broken links
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
pyvec/docs.pyvec.org#516 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
pyvec/docs.pyvec.org#482 ·
Todos los issues de pyvec/docs.pyvec.org
Issues similares
-
json_params_matcher fails on falsy top-level JSON primitives (0, False, "")Posiblemente ocupada @mayureshsonawane17 la tomó hoy. AbiertoWaiting for: Product Owner
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Los mantenedores suelen responder en 5 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Los mantenedores suelen responder en 1 día
-
第二章思考题 8：Skill 追加到末尾不必每轮重新计算 KVAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
bojieli/ai-agent-book#1169 ·
Los mantenedores suelen responder en 1 día
-
priority:low ready-for-dev
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
OpenHands/extensions#738 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
micronaut-projects/micronaut-core#13677 ·
Los mantenedores suelen responder en 1 día