Skip to content

Docs and Examples mix multiple versions #539

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

Closed
1 task
superstes opened this issue Feb 8, 2025 · 3 comments
Closed
1 task

Docs and Examples mix multiple versions #539

superstes opened this issue Feb 8, 2025 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@superstes
Copy link

superstes commented Feb 8, 2025

Suggestion

The docs are a bit confusing as there seem to be (many) major version that can (still) be used.

The experience for new users could be improved a lot with some minor changes to it.

Additional information

If one google's 'Svelvet docs' they might end-up reading the v6-docs: https://www.svelvet.io/v6/basic-usage
The users might not recognize these are docs for a 'legacy' version as the current v10 version is mentioned in the navbar directly above.

The doc's version should be easy to spot. Maybe add a warning on-top if there are newer docs?

Examples

The examples linked in the latest docs are for older versions. Users have to explicitly check the version listed in package.json.

This might be frustrating for new users.

IMHO the examples should at least warn that they are written with/for an older version.

👨‍👧‍👦 Contributing

  • 🙋‍♂️ Yes, I'd love to make a PR to improve these docs!
@superstes superstes added the documentation Improvements or additions to documentation label Feb 8, 2025
@superstes
Copy link
Author

Related: #528

@cyhap01
Copy link
Contributor

cyhap01 commented Feb 18, 2025

Hello, version 11 was released last week. You are correct that the docs are cumulative however for Version 11, I created specific Readme's for version 11 and what features my team worked on and what next. We also labelled the Mintlify Documentation in the Roadmap to specific V11.0.

@superstes
Copy link
Author

Ok - just wanted to point it out

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