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

Have all API help in OpenAPI menu, or have OpenAPI rendering in mkdocs #7883

Open
alexgarel opened this issue Dec 21, 2022 · 4 comments
Open
Labels
API Refactor 📚 Documentation Documentation issues improve the project for everyone. ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. ✅ Task

Comments

@alexgarel
Copy link
Member

alexgarel commented Dec 21, 2022

What

Part of

@alexgarel alexgarel added ✅ Task 📚 Documentation Documentation issues improve the project for everyone. labels Dec 21, 2022
@alexgarel
Copy link
Member Author

@teolemon @Roxie-32 including external markdown in redoc is really easy indeed.
See https://redocly.com/docs/api-reference-docs/guides/embedded-markdown/

@alexgarel
Copy link
Member Author

There also seems to be a sidebars.yaml to configure the left menu (not sure if it works in OSS version).

@alexgarel
Copy link
Member Author

I tried and sidebars in the leftmenu is a feature which is NOT available in community edition !

I have two choices now:

  • either we use a specific template with javascript to inject the menu entries we want (that seems doable, but I'm not sure)
  • either we try https://rapidocweb.com/ which is fully Open Source, but I yet have to see how to use it.

alexgarel added a commit that referenced this issue Jan 20, 2023
fixes:
- #7883 Have all API help in OpenAPI menu, or have OpenAPI rendering in mkdocs 
Copy link
Contributor

This issue has been open 90 days with no activity. Can you give it a little love by linking it to a parent issue, adding relevant labels and projets, creating a mockup if applicable, adding code pointers from https://github.com/openfoodfacts/openfoodfacts-server/blob/main/.github/labeler.yml, giving it a priority, editing the original issue to have a more comprehensive description… Thank you very much for your contribution to 🍊 Open Food Facts

@github-actions github-actions bot added the ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. label Dec 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Refactor 📚 Documentation Documentation issues improve the project for everyone. ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. ✅ Task
Projects
Status: To discuss and validate
Status: Todo
Development

No branches or pull requests

2 participants