-
-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Description
TL;DR: IMHO, the documentation should not link to non existing documentation when the version is not available
Examples :
- https://symfony.com/doc/current/html_sanitizer.html (not available before 6.1)
- https://symfony.com/doc/current/messenger.html (not available before 4.x)
The version menu contains all version even if it was not available for this version.
It is misleading for the user and redirect to a 404 page.
For instance, on HTML Sanitizer for current release, the version where it was introduced is not available anymore.
I can use this component on a 5.4 setup even if the component was introduced in 6.1.
When I'm looking for a component documentation, by the search menu or search engine, I will always be on the current version.
Then, I switch to the closest version to my working project (5.4 in my case). Because the documentation is not available, I will have to jump between version until I find the available one. I'm pretty sure all version where not available before in that menu.
The implication of that behavior is that I have either to know when the component was introduced or which component version I use (will not always be the LTS).
The version menu should contains only the version where a component is available. Alternatively :
- Display the menu in a special group not available
- Customize the page not found to display the closest version where the documentation is available (implicitely introduced)