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

Poor v15 to v16 migration documentations #1884

Open
qu8n opened this issue Feb 4, 2025 · 3 comments
Open

Poor v15 to v16 migration documentations #1884

qu8n opened this issue Feb 4, 2025 · 3 comments

Comments

@qu8n
Copy link

qu8n commented Feb 4, 2025

How can we improve the documentation?

Hey team, I'm excited for all these updates, but the experience of updating to v16 has been challenging.

The current docs is mixing up v15 and v16.

For example, the latest docs page shows v15 and the installation steps lead to users installing v15, yet some example commands are those of v16:
Image

Because v16 is a huge change, what do you think about having separate doc versions for v15 vs v16? Perhaps a navbar dropdown could let users select docs for v15 vs v16?
Image

@Stratus3D
Copy link
Member

Strange, somehow the version on the website didn't get updated properly. I will fix this evening.

@thomas-merz
Copy link

A better migration docu (and doing NO Breaking Changes in minor version at all) should have prevented #1895

@lachieh
Copy link

lachieh commented Feb 6, 2025

A better migration docu (and doing NO Breaking Changes in minor version at all) should have prevented #1895

@thomas-merz Anything pre-1.0.0 always has the potential to be a breaking change. This is clearly outlined in the spec. Semantic Versioning Spec, Item #4:

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

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

No branches or pull requests

4 participants