hyperium / hyperium/hyperium.github.io

Documentation: missing references in Guides, https://hyper.rs/guides/client/json/

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

Nadie ha tomado este issue todavía.

Lenguaje dominante
HTML
Estrellas
34
Forks
71
Merge medio
1 h 9 min
PR fusionados (30 d)
8

Descripción

There's a lot of missing references on the guide page. It'd be a nice little improvement to have the highlighted text parts be resolvable links.

This can be considered an easy fix but it improves the value of the documentation significantly.

One example of this would be the referenced example in https://hyper.rs/guides/client/json/ links to https://docs.rs/hyper/*/guides/client/basic/

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

Abre la página de la guía JSON referenciada e inspecciona el texto resaltado y la referencia de ejemplo. Haz que las referencias faltantes sean enlaces resolubles, incluido el enlace de ejemplo, y luego verifica que la página de la guía resuelva esos enlaces correctamente.

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

Evaluación

Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
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.