Skip to content
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

Merged
merged 1 commit into from
Aug 14, 2024
Merged

docs: rework openapi-generator README.md #871

merged 1 commit into from
Aug 14, 2024

Conversation

ad-world
Copy link
Contributor

@ad-world ad-world commented Aug 9, 2024

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.

@ad-world ad-world self-assigned this Aug 9, 2024
@ad-world ad-world marked this pull request as ready for review August 9, 2024 20:35
@ad-world ad-world requested review from a team as code owners August 9, 2024 20:35
@ad-world ad-world force-pushed the DX-669 branch 2 times, most recently from 141aa5d to 42808ef Compare August 9, 2024 20:40
@ad-world ad-world force-pushed the DX-669 branch 3 times, most recently from ad7df96 to 30518c8 Compare August 9, 2024 21:39
anshchaturvedi
anshchaturvedi previously approved these changes Aug 9, 2024
Copy link
Contributor

@anshchaturvedi anshchaturvedi left a 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!

anshchaturvedi
anshchaturvedi previously approved these changes Aug 9, 2024
bitgopatmcl
bitgopatmcl previously approved these changes Aug 12, 2024
@ad-world
Copy link
Contributor Author

@andrew-scott-fischer am I good to merge? There's another unresolved comment!

@andrew-scott-fischer
Copy link
Contributor

Copy link
Contributor

@ericcrosson-bitgo ericcrosson-bitgo left a 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!

packages/openapi-generator/README.md Show resolved Hide resolved
packages/openapi-generator/README.md Outdated Show resolved Hide resolved
packages/openapi-generator/README.md Outdated Show resolved Hide resolved
packages/openapi-generator/README.md Outdated Show resolved Hide resolved
@ad-world
Copy link
Contributor Author

@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

@ad-world ad-world dismissed stale reviews from ericcrosson-bitgo and bitgopatmcl via a61adab August 12, 2024 19:37
@ericcrosson-bitgo
Copy link
Contributor

@ad-world Will you please squash this PR's commits?

@ad-world ad-world merged commit 8b8713c into master Aug 14, 2024
6 checks passed
@ad-world ad-world deleted the DX-669 branch August 14, 2024 15:28
Copy link

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Copy link

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants