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

Suggesting new documentation #533

Open
AdrielBento opened this issue Dec 17, 2024 · 3 comments
Open

Suggesting new documentation #533

AdrielBento opened this issue Dec 17, 2024 · 3 comments

Comments

@AdrielBento
Copy link

Hi Tim, great job creating and maintaining this library. When I tried to use the library, I had some difficulty reading and interpreting the documentation. I think we could make some improvements to it.

Do you mind if I make a contribution to improving the documentation, switching to VitePress among other improvements?

@timgit
Copy link
Owner

timgit commented Jan 8, 2025

I don't mind docs improvements. They are a work in progress, but I'd prefer this is deferred until after v11 is merged, since this would invalidate some of the changes

@michalczukm
Copy link

+1. I am happy to help there as well!

VitePress sounds like a good idea.
I'd put one requirement there - it should support search!

I used to docs being in the plain markdown - and just search via cmd+f on the page 😅
Now I am confused where the pieces of docs live 😅

@AdrielBento
Copy link
Author

No problem @timgit, I'll wait for the version 11 merge. Any prediction or estimate of when these merge will happen?

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

No branches or pull requests

3 participants