reactjs / reactjs/react.dev

Documentation feedback

Abierto
#476 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
JavaScript
Estrellas
11.8k
Forks
7.9k
Merge medio
1 d 11 h
PR fusionados (30 d)
11

Descripción

As with lots of repos and libs, I often find myself thinking about improvements to and gaps within docs as I'm stepping through. Sure, there's ways of capturing it; submitting an issue, Gitter, some doc platforms allow contribution links from within the docs themselves.

If possible, I think it would be a great feature to include (post-Github login) just-in-time commentary on docs that fits into a lightweight review/contrib workflow - I'm thinking it would look/function similarly to Medium.com's annotation feature.

Perhaps it's feature-worthy instead of "just file an issue" etc, because performing available contribution steps is certainly possible but it removes learners from their learning experience and train of thought (also busy experienced devs). Why not let learners stay on track while also making annotations that, if reviewed after learning (or when finding a mistake) can then also be shared/submitted into a usable workflow for maintainers?

This would also allow contributions in the form of documentation review that doesn't require living and breathing in the contrib ecosystem (just want to get learning, I'll contrib when I'm ready, but my feedback could still be valuable to others).

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

La issue no menciona archivos, pruebas ni puntos de entrada. Empieza revisando el flujo de contribución existente de react.dev y la experiencia de anotaciones solicitada después de iniciar sesión en GitHub. Define el alcance de las anotaciones y de la revisión por parte de los mantenedores antes de la implementación; el trabajo estará terminado cuando los estudiantes puedan enviar comentarios útiles sobre la documentación sin salir del flujo de aprendizaje.

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

Evaluación

Stack tecnológico
javascript, react
Área
documentation, frontend
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
20/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.