Add links to generated documentation in README

Aperta
#343 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

@nora-soderlund ci sta già lavorando.

Dal 19/2/2023.

  • #447 di @nora-soderlund — aperta

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
52/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
openapi, postman
Ambito
documentation

Direzione di ricerca

Inizia dalla sezione «Description» del README ed esamina la tabella delle API insieme alle pagine della documentazione di Google Maps Platform. Aggiungi link alla documentazione renderizzata per le API corrispondenti, quindi verifica che ogni link della tabella apra la pagina prevista e che la formattazione del README rimanga chiara.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Nessun dato sulla lingua
Stelle
118
Fork
94
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di googlemaps/openapi-specification

Tutte le issue di googlemaps/openapi-specification

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.