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

Integrate REST API documentation in Docusaurus website #7

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

wborn
Copy link
Member

@wborn wborn commented Sep 12, 2024

  • Add docusaurus-plugin-openapi-docs
  • Generate REST API documentation
  • Document how to update the OpenAPI documentation
  • Move documentation links from top to sidebar
  • Expand "User Guide" category automatically
  • Upgrade Docusaurus from 3.4.0 to 3.5.2
  • Upgrade Yarn from 4.1.0 to 4.4.1

Fixes #6


After merging the PR it will look like my PoC except for the versioning and UI Components.

* Add docusaurus-plugin-openapi-docs
* Document how to update the OpenAPI documentation
* Move documentation links from top to sidebar
* Expand "User Guide" category automatically
* Upgrade Docusaurus from 3.4.0 to 3.5.2
* Upgrade Yarn from 4.1.0 to 4.4.1
@wborn wborn requested a review from richturner September 12, 2024 08:54
@wborn wborn merged commit 561acf5 into main Sep 12, 2024
2 checks passed
@wborn wborn deleted the add-rest-api-docs branch September 12, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integrate REST API documentation in Docusaurus website
2 participants