microsoft / microsoft/OpenAPI.NET
Add conceptual docs for OpenAPI
Offen
Dieses Issue hat noch niemand übernommen.
type:documentation
type:epic
- Vorherrschende Sprache
- C#
- Sterne
- 1.6k
- Forks
- 286
- Ø Merge
- 6 Std. 38 Min.
- Gemergte PRs (30 T.)
- 35
Beschreibung
- 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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die vorhandenen Dokumentationseinstiegspunkte für die Bibliothek OpenAPI Writers und das Tool Hidi zu finden. Lege den Umfang der Inhalte für den Einstieg und der Tutorials für beide fest, einschließlich eines Szenarios, in dem Hidi mit einem API-Manifest aus Graph Explorer verwendet wird. Als abgeschlossen gilt die Aufgabe, wenn die konzeptionelle Dokumentation und die angeforderten Tutorials für beide Tools hinzugefügt wurden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- csharp, openapi
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100