microsoft / microsoft/OpenAPI.NET
Add conceptual docs for OpenAPI
Open
Nobody has claimed this yet.
type:documentation
type:epic
- Dominant language
- C#
- Stars
- 1.6k
- Forks
- 286
- Avg merge
- 6h 38m
- Merged PRs (30d)
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing documentation entry points for the OpenAPI Writers library and Hidi tool. Define the getting-started and tutorial coverage for both, including a scenario using Hidi with an API manifest from Graph Explorer. Done means the conceptual documentation and requested tutorials are added for both tools.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100