Add links to generated documentation in README

Ouverte
#343 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

@nora-soderlund y travaille déjà.

Depuis le 19/2/2023.

  • #447 par @nora-soderlund — ouverte

Évaluation

Difficulté
1/5
Temps estimé
Moins d'une heure
Accessibilité débutants
52/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
openapi, postman
Domaine
documentation

Piste de recherche

Commencez par la section « Description » du README et examinez le tableau des API en parallèle des pages de documentation de Google Maps Platform. Ajoutez des liens vers la documentation rendue pour les API correspondantes, puis vérifiez que chaque lien du tableau ouvre la page prévue et que la mise en forme du README reste claire.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Aucune donnée de langage
Étoiles
118
Forks
94
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de googlemaps/openapi-specification

Toutes les issues de googlemaps/openapi-specification

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.