docs: add installation and complete usage guide #9
Conversation
🦋 Changeset detectedLatest commit: fa52160 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
| npm i -D openapi-msw | ||
| ``` | ||
|
|
||
| **Note:** This package has a peer-dependency to MSW **v2**. There is no plan to |
There was a problem hiding this comment.
Opinionated structuring idea: Add a "Prerequisites" section before installation, containing this note and the first paragraph of the usage guide. That way, its clear what needs to be done before installing this package makes sense. Also, the "Usage Guide > Getting Started" subsection title might obsolete then.
There was a problem hiding this comment.
I am considering other changes to the docs as well, such as a list of key features/achievements in in the beginning and and outlining the motivation behind openapi-msw, i.e. errors for spec conflicts across the stack (app + test code). I will keep this idea in mind and come back to it when I make other improvements to the docs as well.
This PR adds documentation about using OpenAPI-MSW.