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

docs: Improve API Docs Formatting #241

Closed
Tracked by #236
missBerg opened this issue Jan 30, 2025 · 3 comments · Fixed by #308
Closed
Tracked by #236

docs: Improve API Docs Formatting #241

missBerg opened this issue Jan 30, 2025 · 3 comments · Fixed by #308

Comments

@missBerg
Copy link
Contributor

missBerg commented Jan 30, 2025

The automatic generation of the docs of the API isn't formatted well.

We need to update the formatting, see current config for formatting in site/crd-ref-docs

@missBerg missBerg mentioned this issue Jan 30, 2025
8 tasks
@missBerg
Copy link
Contributor Author

missBerg commented Feb 1, 2025

See what it currently looks like when generated: https://envoy-ai-gateway.netlify.app/docs/api_references

@ericmariasis
Copy link
Contributor

I can take this one.

@ericmariasis
Copy link
Contributor

I figured side navigation might be nice as well but I haven't gotten that to work yet.

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 a pull request may close this issue.

2 participants