googlemaps / googlemaps/openapi-specification

Add links to generated documentation in README

Aperta
#343 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
triage me type: feature request
Lingua principale
Nessun dato sulla lingua
Stelle
119
Fork
95
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

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.

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.