Add links to generated documentation in README

未關閉
#343 0 則留言 0 個 reaction 已指派 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
PR 合併指標
30 天內沒有已合併 PR

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

googlemaps/openapi-specification 的其他 Issue

查看 googlemaps/openapi-specification 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。