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.

Sign up for GitHub

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

Jump to bottom

Nicer docusaurus openapi docs #722

Merged
merged 3 commits into from
Jan 15, 2023
Merged

Nicer docusaurus openapi docs #722

merged 3 commits into from
Jan 15, 2023

Conversation

andrewm4894
Copy link
Collaborator

@andrewm4894 andrewm4894 commented Jan 15, 2023 •
edited
Loading

  • uses this plugin to make a nice static site docusaurus based api section of docs site.
  • adds some nicer postman code snippets etc too as part of api docs.
  • makes api docs more "self hosted" as opposed to the dynamic swagger url approach.

image

@andrewm4894 andrewm4894 marked this pull request as ready for review January 15, 2023 00:15
@github-actions
Copy link

❌ pre-commit failed.
Please run pre-commit run --all-files locally and commit the changes.
Find more information in the repository's CONTRIBUTING.md

@andrewm4894 andrewm4894 enabled auto-merge (squash) January 15, 2023 00:17
yk
yk approved these changes Jan 15, 2023
View reviewed changes
Copy link
Collaborator

@yk yk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you!

@andrewm4894 andrewm4894 merged commit f45de9a into LAION-AI:main Jan 15, 2023
@andrewm4894 andrewm4894 deleted the nicer-docusaurus-openapi-docs branch January 15, 2023 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yk yk yk approved these changes

@andreaskoepf andreaskoepf Awaiting requested review from andreaskoepf andreaskoepf is a code owner

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@andrewm4894 @yk @fozziethebeat