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

Website/Docs Versioning #938

Open
sbreiler opened this issue Nov 22, 2024 · 1 comment
Open

Website/Docs Versioning #938

sbreiler opened this issue Nov 22, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sbreiler
Copy link

Hello,

first of all, I really like Valibot and just switched over from Zod. The documentation is excellent - thanks for that! 👌

However, I noticed that, due to hosting the website directly from the latest GitHub source (as I understand it), it’s not (easily) possible to have versioned documentation or playgrounds.

I see two major issues with not having versioning:

  • If you share a playground link in an issue, it might stop working in the future or give different results compared to the version it was created with.
  • You can’t navigate between different API documentation versions. I really like how Ramda handles this, for example.

Perhaps we can start a discussion about this if you also think that this is a issue

@fabian-hiller fabian-hiller self-assigned this Nov 22, 2024
@fabian-hiller fabian-hiller added the documentation Improvements or additions to documentation label Nov 22, 2024
@fabian-hiller
Copy link
Owner

Thank you for creating this PR. I agree and see the benefit of versioning, but I also see the extra effort it requires. We will probably provide extra documentation for major releases, but probably not for minor ones. But I am happy to discuss this here. Everyone should feel welcome to contribute to the discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants