Add links to generated documentation in README

Offen
  • Stimmt etwas nicht?
#343 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

@nora-soderlund arbeitet bereits daran.

Seit 19.2.2023.

  • #447 von @nora-soderlund — offen

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
52/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
openapi, postman
Bereich
documentation

Rechercherichtung

Beginne im Abschnitt „Description“ der README und prüfe die API-Tabelle zusammen mit den Dokumentationsseiten von Google Maps Platform. Füge für die entsprechenden APIs Links zur gerenderten Dokumentation hinzu und überprüfe anschließend, dass jeder Tabellenlink die vorgesehene Seite öffnet und die README-Formatierung übersichtlich bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Keine Sprachdaten
Sterne
118
Forks
94
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus googlemaps/openapi-specification

Alle Issues in googlemaps/openapi-specification

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.