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

Do beta (v3) docs exist? The 'v3 Documentation' link goes to v2 Docs currently. #759

Open
ArthurD opened this issue Dec 5, 2021 · 0 comments

Comments

@ArthurD
Copy link

ArthurD commented Dec 5, 2021

The repo's v3 branch README has a link to go to the 'v3 docs' but it actually takes you to the v2 docs. See screenshot:
v3-docs-missing

I suspect a decent bit of the confusion is related to this -- the v3 code is much better & is overall just far easier to work with (especially the styling) -- but without documentation, it's a lot of fumbling around to try to figure out what the usage API is.

Personally, I had inadvertently been trying to use v2 syntax with the v3 codebase -- causes me lots of confusion. Much smoother sailing now that I've realized the issue, though unfortunately I'm going to stick with the v2 implementation, at least for now, at least until v3 has some documentation/examples. And maybe it already does and I'm just too dense to find/see them.

Nonetheless -- awesome project. Please don't take this as criticism at all BTW! The project is great and, especially the improvements in v3, it looks fantastic & it absolutely satisfies our requirements & more. If anything, I just wanted to relay my experience in hopes of helping the project & others in the future, even if in a very small way!

Thank you! :)

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

1 participant