[Proposal] Add user guide, especially about directives
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- ruby
- Área
- documentation
Línea de trabajo
Comience revisando la guía japonesa de RDoc enlazada en el issue, especialmente su cobertura de las directivas. Defina el alcance de una guía de usuario en inglés que cubra las directivas y otras funciones de RDoc, y traduzca y organice ese material para que se convierta en una única referencia para usuarios y desarrolladores.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
I noticed that there's no list for directives. In fact, there's not a comprehensive user guide in English (the only I found was in Japanese: https://docs.ruby-lang.org/ja/latest/library/rdoc.html).
Adding user guide has two purposes. First, of course, users will refer to the guide so that they can use directives and other features of RDoc more effectively. Second, it will be a single source of truth for RDoc behavior so developers can rely on it.
I suggest the first version of the guide could be a direct translation of the Japanese guide mentioned above since we don't have to talk about what should be in the guide.
Any thoughts?
- Lenguaje dominante
- Ruby
- Estrellas
- 930
- Forks
- 472
- Merge medio
- 2 d 8 h
- PR fusionados (30 d)
- 12
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 ruby/rdoc
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationPosiblemente ocupada @OskarEichler la tomó hace 80 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
ruby/rdoc#1759 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
markdown html excerpt includes link partsPosiblemente ocupada @anyingiit la tomó hace 26 días. Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 66/100
Los mantenedores suelen responder en 1 día
-
Regexp generated from unescaped input in #expand_classPosiblemente ocupada @jaynetics la tomó hace 39 días. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 25/100
Los mantenedores suelen responder en 1 día
Issues similares
-
bug f:request-creation professional
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
mysociety/alaveteli#9733 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
needs verification
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
Los mantenedores suelen responder en 13 días
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
betagouv/conseillers-entreprises#4808 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100