microsoft / microsoft/OpenAPI.NET
Add conceptual docs for OpenAPI
Aberta
Ninguém assumiu esta issue ainda.
type:documentation
type:epic
- Linguagem predominante
- C#
- Estrelas
- 1.6k
- Forks
- 286
- Merge médio
- 6h 38min
- PRs com merge (30d)
- 35
Descrição
- 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
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece localizando os pontos de entrada da documentação existente para a biblioteca OpenAPI Writers e a ferramenta Hidi. Defina a cobertura do guia de introdução e dos tutoriais para ambos, incluindo um cenário que use o Hidi com um manifesto de API do Graph Explorer. A tarefa estará concluída quando a documentação conceitual e os tutoriais solicitados forem adicionados para ambas as ferramentas.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- csharp, openapi
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 42/100