feat: add redoc to documentation #1003
Open
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
✅ Deploy Preview for openfeature ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Lukas Reining <[email protected]>
lukas-reining
force-pushed
the
feat/add-ofrep-to-docs
branch
from
f2de0f3 to
4c78ca2
Compare
Renovate will update submodules automatically. |
Signed-off-by: Lukas Reining <[email protected]>
|
@beeme1mr sounds good! |
|
You can check the result here: https://deploy-preview-1003--openfeature.netlify.app/docs/reference/technologies/ofrep/ |
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.
This PR
Adds OpenAPI docs for OFREP to the docs section.
I chose between https://github.com/rohit-gohri/redocusaurus and https://github.com/PaloAltoNetworks/docusaurus-openapi-docs.
In the end I chose the first, because
docusaurus-openapi-docsexpects to generate it's own sidebar which is really hard to merge with our sidebar, without giving up the auto-generation of our sidebar.Please leave feedback if this is enough or if we want some more prose.
Fixes: #452
Also we need a mechanism to update the submodule when we do changes in the protocol repo. @toddbaert @beeme1mr how can we do it best? Like with the SDK docs?