-
Notifications
You must be signed in to change notification settings - Fork 102
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
docs: user can select version (instead of HEAD/nightly) #348
Comments
Not in favor. The website docs allow us to make hints and other docs available via the website search (and search engines).
This would be ideal. But the HEAD docs should stay at the current paths, because:
The version-specific docs could live at e.g. Edit: instead of the above, let's start by using |
Just adding that we are seeing increasing confusion since people look at docs (as we tell them to) and find documentation or code examples that simply won't work for them (since they use 0.10, as we tell them to). At the very least, we should consider adding a (floating?) disclaimer at the top of the page that this documentation refers to nightly and, if in doubt, check with |
Instead of this, let's double-down on the |
But that won't work with current "soft deprecations" which hide the documentation. (In this case, users will find no docs for them: the old ones are gone, but the new shown ones are inapplicable.) |
They will be on deprecated.txt ? |
There have been some instances where users are confused why the documentation in neovim.io doesn't work only to realize that they don't use nightly. I have a few ideas on how we could tackle this:
Allow users to choose the version for the documentation. I think a good example of this is cmake (crazy, right?), where the documentation version is prominently shown at the top in an easy place.
Use the latest stable in the documentation instead of nightly. This is probably easier to implement. A problem might be that nightly users might start complaining they can't find docs for nightly features.
Open to other suggestions.
The text was updated successfully, but these errors were encountered: