hyperium / hyperium/hyperium.github.io
Documentation: missing references in Guides, https://hyper.rs/guides/client/json/
オープン
まだ誰も着手していません。
- 主要言語
- HTML
- スター
- 34
- フォーク
- 71
- 平均マージ
- 1時間 9分
- マージ済み PR（30日）
- 8
説明
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/
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
参照されている JSON ガイドページを開き、強調表示されたテキストと例の参照を確認します。欠落している参照を解決可能なリンクにし、例のリンクも含めて、その後ガイドページでそれらのリンクが正しく解決されることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100