mruby / mruby/mruby.github.io

How do I properly add newly generated docs to mruby.github.io?

Abierto
#45 6 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
SCSS
Estrellas
26
Forks
32
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

The last bit of documentation I wrote was approved of and merged by @matz into mruby. Now I want to add the documentation to mruby.org. Usually what would happen is that I'd generate the doc using mruby-yard. In this case, the only thing that changed was that I added docs to string.h. So I'd then take the generated doc in this case a file called mruby_2Fstring.h.html. Then I'd just copy and paste it to the proper directory in mruby.github.io then I'd do a PR. Of course, if it's merged it would then go live. Is that still okay? Because I remember before @zzak said that the size was too big. I want to make sure I do this correctly this time!

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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

Empieza revisando la página generada mruby_2Fstring.h.html, la ruta de generación de mruby-yard y el diseño existente de mruby.github.io. Lee el PR #39 anterior por la preocupación relacionada con el tamaño y, después, confirma el proceso actual de publicación con los mantenedores. Se considera terminado cuando haya un procedimiento acordado y, si se solicita, un PR que lo siga.

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

Evaluación

Stack tecnológico
ruby
Área
documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Necesita aclaración
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.