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

feat: add redoc to documentation #1003

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

lukas-reining
Copy link
Member

@lukas-reining lukas-reining commented Feb 22, 2025

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?

Copy link

netlify bot commented Feb 22, 2025

Deploy Preview for openfeature ready!

Name Link
🔨 Latest commit 207c2a9
🔍 Latest deploy log https://app.netlify.com/sites/openfeature/deploys/67bb298d7c9a6a0008cb3ad4
😎 Deploy Preview https://deploy-preview-1003--openfeature.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@beeme1mr
Copy link
Member

Also we need a mechanism to update the submodule when we do changes in the protocol repo.

Renovate will update submodules automatically.

@lukas-reining
Copy link
Member Author

@beeme1mr sounds good!
I had to fix the submodules, missed to push the submodule itself.

@lukas-reining
Copy link
Member Author

@beeme1mr
Copy link
Member

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?

  1. Create a landing page at /doc/reference/technologies/ofrep that explains what it is and why it exists.
  2. Move the OpenAPI as either a child page or somewhere else. Possibility under the spec.

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?

image

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.

@lukas-reining
Copy link
Member Author

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?

Hey @beeme1mr this makes sense to me, this is why I was asking for input on it :)

Create a landing page at /doc/reference/technologies/ofrep that explains what it is and why it exists.

Yes this sounds good!

Move the OpenAPI as either a child page or somewhere else. Possibility under the spec.

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.

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?

I think yes, will have to check the redocs docs.

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.

That would be cool!

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.

[DOC] add swagger live-docs for OFREP
2 participants