ruby / ruby/docs.ruby-lang.org

Generate all Ruby versions' documentation with the latest (released) RDoc

Abierto
#153 0 comentarios 4 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Ruby
Estrellas
53
Forks
27
Merge medio
1 h 39 min
PR fusionados (30 d)
2

Descripción

I recently made quite a few theme improvements to RDoc, along with community contributed changes like SEO tags...etc., which are all applied to the master documentation (https://docs.ruby-lang.org/en/master/index.html).
But since most of users will still be using Ruby 3.3 and prior versions for years to come, I think it'd be better if we can apply the same changes to their documentation too. I'd appreciate some pointers or even collaborations to make that happen. Thank you 🙂

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Compara la documentación maestra en docs.ruby-lang.org/en/master/index.html con la documentación versionada de Ruby 3.3 y anteriores para identificar las diferencias de generación. Después, inspecciona los puntos de entrada de generación de documentación de este repositorio y determina cómo se puede aplicar el RDoc publicado más recientemente en las versiones de Ruby compatibles; se considera terminado cuando los sitios versionados contienen las mejoras solicitadas de theme y SEO.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
ruby
Área
build-system, documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.