hyperium / hyperium/hyperium.github.io

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

Aperta
#18 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
HTML
Stelle
34
Fork
71
Merge medio
1h 9m
PR unite (30g)
8

Descrizione

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/

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Apri la pagina della guida JSON referenziata e ispeziona il testo evidenziato e il riferimento di esempio. Rendi i riferimenti mancanti link risolvibili, incluso il link di esempio, quindi verifica che la pagina della guida risolva correttamente tali link.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.