-
Notifications
You must be signed in to change notification settings - Fork 6.1k
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
feat(docs): autogenerate API documentation #27573
base: master
Are you sure you want to change the base?
feat(docs): autogenerate API documentation #27573
Conversation
Missing ChangesetsThe following package(s) are changed by this PR but do not have a changeset:
See CONTRIBUTING.md for more information about how to add changesets. Changed Packages
|
156c510
to
ae114a7
Compare
Thanks for the contribution! |
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.
This looks like a great addition to the docs @aramissennyeydd, thanks for taking this on!
Looks good over all, curious about two things:
- Whats the impact on build time?
- Do we need to manage the new sidebars manually?
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
704463a
to
8e11767
Compare
Hey, I just made a Pull Request!
Addresses #26894.
This uses https://github.com/PaloAltoNetworks/docusaurus-openapi-docs to render our existing specs. The goal here is to make the OpenAPI spec the source of truth for docs + API definition. I moved the existing catalog docs into the spec and saw really nice results in the autogenerated markdown.
TODO:
✔️ Checklist
Signed-off-by
line in the message. (more info)