Skip to content

Improve: API docs experience #259

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

Open
ShadowArcanist opened this issue Apr 6, 2025 · 2 comments
Open

Improve: API docs experience #259

ShadowArcanist opened this issue Apr 6, 2025 · 2 comments
Assignees
Labels
✨ Enhancement Suggestions to improve or add detail to existing docs. ⚠️ High Priority Critical documentation tasks requiring immediate attention.

Comments

@ShadowArcanist
Copy link
Member

https://fumadocs.vercel.app/docs/openapi way better layout + color choice for API docs in both light and dark mode.

Image

@ShadowArcanist ShadowArcanist added ⚠️ High Priority Critical documentation tasks requiring immediate attention. ✨ Enhancement Suggestions to improve or add detail to existing docs. labels Apr 6, 2025
@ShadowArcanist ShadowArcanist moved this to To Do (High Priority) in Coolify Documentation Apr 6, 2025
@ShadowArcanist
Copy link
Member Author

@justserdar I think this one is a very big task, so I didn't add it to any cycle. we can work in this slowly

@justserdar
Copy link
Contributor

I agree, we made progress with the new collapsible sidebar in the open api section of the docs. The next step would a full width layout for that section like fumadocs reference. Should be doable w/o too much time, I recommend we just use a custom layout wrapping those pages.

@justserdar justserdar changed the title Improve: API docs experince Improve: API docs experience Apr 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Enhancement Suggestions to improve or add detail to existing docs. ⚠️ High Priority Critical documentation tasks requiring immediate attention.
Projects
Status: To Do (High Priority)
Development

No branches or pull requests

2 participants