hyperium / hyperium/hyperium.github.io
Documentation: missing references in Guides, https://hyper.rs/guides/client/json/
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- HTML
- Sterne
- 34
- Forks
- 71
- Ø Merge
- 1 Std. 9 Min.
- Gemergte PRs (30 T.)
- 8
Beschreibung
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/
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Öffne die referenzierte JSON-Leitfadenseite und prüfe den hervorgehobenen Text sowie die Beispielreferenz. Mache die fehlenden Referenzen auflösbare Links, einschließlich des Beispiel-Links, und überprüfe anschließend, dass die Leitfadenseite diese Links korrekt auflöst.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100