microsoft / microsoft/OpenAPI.NET
Add conceptual docs for OpenAPI
Ouverte
Personne n'a encore pris cette issue.
type:documentation
type:epic
- Langage dominant
- C#
- Étoiles
- 1.6k
- Forks
- 286
- Merge moyen
- 6 h 38 min
- PR mergées (30 j)
- 35
Description
- Include getting started docs & tutorials for OpenAPI Writers lib
- Include getting started docs & tutorials for Hidi tool and add scenario-based tutorials eg using Hidi with API manifest from Graph Explorer
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par localiser les points d’entrée de la documentation existante pour la bibliothèque OpenAPI Writers et l’outil Hidi. Définissez le contenu de prise en main et des tutoriels pour les deux, y compris un scénario utilisant Hidi avec un manifeste d’API provenant de Graph Explorer. La tâche sera considérée comme terminée lorsque la documentation conceptuelle et les tutoriels demandés auront été ajoutés pour les deux outils.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- csharp, openapi
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 42/100