-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: rework openapi-generator README.md #871
Conversation
141aa5d
to
42808ef
Compare
ad7df96
to
30518c8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks great! i didn't exactly proofread but did a quick skim and its very information, so that is always a good thing. good stuff Arya!
@andrew-scott-fischer am I good to merge? There's another unresolved comment! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the thorough review, all!
@ericcrosson-bitgo the actual stripping happens in another step of the process here. But I'm now thinking that we may just get rid of this, as @andrew-scott-fischer has mentioned that it is not the expected result of the @unstable tag to remove the docs completely, rather than annotate them as unstable. I guess we just need to make sure that this information is captured correctly in dev-portal |
a61adab
@ad-world Will you please squash this PR's commits? |
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
🎉 This PR is included in version @api-ts/[email protected] 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
DX-669
This is a ticket to rework the README for openapi-generator. This ticket adds a table of contents, and it also adds a generator reference at the end to showcase the different features that this generator supports for adding openapi documentation.