[DOCS-3265] Use standalone Redoc HTML #50
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrodewig
force-pushed
the
use-redoc-html
branch
5 times, most recently
from
b56cb88 to
4e63fe9
Compare
jrodewig
force-pushed
the
use-redoc-html
branch
from
4e63fe9 to
f1bba14
Compare
Shadid12
approved these changes
Aug 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
You have to run
npm run docsto generate the API ref docs every time you update the OpenAPI spec.Solution
Use the Redocly HTML standalone to render the OpenAPI spec as docs instead. The docs are automatically updated when anyone updates the spec.
Also adds a Github Action to validate changes to the OpenAPI spec.
Preview
https://refined-github-html-preview.kidonng.workers.dev/fauna/js-sample-app/raw/use-redoc-html/docs/index.html