Add links to generated documentation in README

オープン
  • 何か問題がありますか？
#343 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

@nora-soderlund がすでに取り組んでいます。

2023年2月19日 から。

  • #447 @nora-soderlund による — オープン

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
52/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
openapi, postman
領域
documentation

調査の方向性

README の「Description」セクションから始め、Google Maps Platform のドキュメントページと併せて API テーブルを確認します。対応する API のレンダリング済みドキュメントへのリンクを追加し、その後、テーブル内のすべてのリンクが意図したページを開くこと、および README のフォーマットが明確なままであることを確認します。

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

説明

triage me type: feature request

The README for this repo lists the APIs and provides a link to Postman, but if I would like to browse rendered documentation it would be helpful to know where I can see the rendered docs.

Perhaps adding a column to the table in https://github.com/googlemaps/openapi-specification/blob/main/README.md#description with links to the corresponding pages in https://developers.google.com/maps/documentation/ would be the most straightforward way to do this.

主要言語
言語のデータがありません
スター
118
フォーク
94
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

googlemaps/openapi-specification のほかの issue

googlemaps/openapi-specification の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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