Add conceptual docs for OpenAPI

Open
#1,297 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp, openapi
Domain
documentation

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.

Description

type:documentation type:epic
  • 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
Dominant language
C#
Stars
1.6k
Forks
286
Avg merge
6h 38m
Merged PRs (30d)
35

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/OpenAPI.NET

All issues in microsoft/OpenAPI.NET

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.