hyperium / hyperium/hyperium.github.io
Documentation: missing references in Guides, https://hyper.rs/guides/client/json/
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 34
- Forks
- 71
- Avg merge
- 1h 9m
- Merged PRs (30d)
- 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/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the referenced JSON guide page and inspect the highlighted text and the example reference. Make the missing references resolvable links, including the example link, then verify the guide page resolves those links correctly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100