hyperium / hyperium/hyperium.github.io
Documentation: missing references in Guides, https://hyper.rs/guides/client/json/
Personne n'a encore pris cette issue.
- Langage dominant
- HTML
- Étoiles
- 34
- Forks
- 71
- Merge moyen
- 1 h 9 min
- PR mergées (30 j)
- 8
Description
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/
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Ouvrez la page du guide JSON référencée et inspectez le texte mis en évidence ainsi que la référence d’exemple. Rendez les références manquantes accessibles sous forme de liens résolubles, y compris le lien d’exemple, puis vérifiez que la page du guide résout correctement ces liens.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100