-
Notifications
You must be signed in to change notification settings - Fork 65
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: add redoc to documentation #1003
base: main
Are you sure you want to change the base?
Conversation
✅ 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]>
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/ |
Hey @lukas-reining, thanks for kicking this off. It's nice to have the OpenAPI docs included but I'm not sure it makes much sense without more context. What do you think about this?
Additional feedback on the page itself. Can the "OFREP Core" and "OFREP Extension" be either removed or moved to the right side of the page? Also, as a follow up, we should add in our OFPRE providers to the ecosystem. I'd be happy to help with that if you'd like. Thanks again! This is a great start. |
Hey @beeme1mr this makes sense to me, this is why I was asking for input on it :)
Yes this sounds good!
I was wondering about what makes sense. I thought rendering it here would be coherent with the rest of the docs, and especially easier to integrate into the docusaurus pages.
I think yes, will have to check the redocs docs.
That would be cool! |
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-docs
expects 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?