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: refactor documentation #514

Closed
wants to merge 34 commits into from

Conversation

roushou
Copy link
Contributor

@roushou roushou commented Jun 11, 2024

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:

  • Things are packed and unorganized which make harder to know where to look
  • There are a lot of superfluous content like code blocks showing return values true, 1000 etc...
  • Showing the HTML generated is not necessary following the discussions on this PR feat: refacto CSS #500
  • There are a lot of copy paste and often with some parts tied together which make it hard to maintain

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.

@roushou roushou marked this pull request as ready for review June 13, 2024 19:11
@roushou
Copy link
Contributor Author

roushou commented Jun 13, 2024

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 code-group blocks where the first tab is a Preview and the second the Code used for the preview.

image

There are a lot of improvements to be done like using snippets so we can benefit from reusability and all the LSP stuff.

Some wording have been changed so feel free to adapt it to your taste.

Also contents in return html blocks have been removed because I don't think that's relevant to show anymore and it's just too much work to maintain.

@Zizzamia
Copy link
Contributor

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.

@roushou
Copy link
Contributor Author

roushou commented Jun 14, 2024

Makes sense. Leaving this PR open and will close if there's no positive feedback in the following days.

@roushou
Copy link
Contributor Author

roushou commented Jun 17, 2024

Closing since nobody seems up for it

@roushou roushou closed this Jun 17, 2024
@roushou roushou deleted the refacto-documentation branch June 17, 2024 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants