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

オープン
#18 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

参照されている JSON ガイドページを開き、強調表示されたテキストと例の参照を確認します。欠落している参照を解決可能なリンクにし、例のリンクも含めて、その後ガイドページでそれらのリンクが正しく解決されることを確認します。

索引モデルが issue の本文から書いたものです。

説明

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/

主要言語
HTML
スター
34
フォーク
71
平均マージ
1時間 9分
マージ済み PR(30日)
8

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

hyperium/hyperium.github.io のほかの issue

hyperium/hyperium.github.io の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。