feat: client config for documenting installation instructions #207
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
This create a new optional
installationproperty on clients that allows us to document how to install that given client. We have this same work in@readme/oas-to-snippet1 but because wth #206 I'm moving some of this work to be loaded as a plugin in that library it makes more sense for these installation instructions to live as close to the client snippet generation code as possible.And because this is adding an optional property to the client config I'm not going to treat this as a breaking change.
Footnotes
https://github.com/readmeio/oas/blob/main/packages/oas-to-snippet/src/supportedLanguages.ts#L43 ↩