microsoft / microsoft/OpenAPI.NET

Add conceptual docs for OpenAPI

Aperta
#1,297 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

type:documentation type:epic
Lingua principale
C#
Stelle
1.6k
Fork
286
Merge medio
6h 38m
PR unite (30g)
35

Descrizione

  • 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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando i punti di accesso alla documentazione esistente per la libreria OpenAPI Writers e lo strumento Hidi. Definisci la copertura della guida introduttiva e dei tutorial per entrambi, incluso uno scenario che utilizzi Hidi con un manifesto API di Graph Explorer. L'attività è completata quando la documentazione concettuale e i tutorial richiesti sono stati aggiunti per entrambi gli strumenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp, openapi
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.