-
Notifications
You must be signed in to change notification settings - Fork 152
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: refactor documentation #514
Conversation
43d3d85
to
c36ede1
Compare
This PR might be better to be reviewed by launching the documentation locally. The main difference with the current documentation is that it emphasizes demos of components by using There are a lot of improvements to be done like using Some wording have been changed so feel free to adapt it to your taste. Also contents in |
One quick thought, I am not a fan of Demo being hidden by a tab. Mostly because it adds an extra click when seen. Even thought they feel cleaner, I like see demo components as I scroll, without the need to click. |
Makes sense. Leaving this PR open and will close if there's no positive feedback in the following days. |
Closing since nobody seems up for it |
This PR is a first step to make the documentation more readable and maintainable. There's a lot of subjectivity so feel free to discard if it doesn't align with your taste. The concerns I have with the current documentation:
true
,1000
etc...The main reference I have is Shadcn because I find it simple to read. I find Radix UI documentation much better because I don't have to switch between tabs but I don't know how to replicate it using Vocs. One common point is that things have enough spacing between them.
There are still some work so feel free to add your changes. Or merge it if you prefer to do it incrementally.