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

Guidance on docs versioning #3148

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

carljparker
Copy link
Contributor

I've received feedback that the versioning UI is both not obvious enough and also that it is not clear what it means. Adding some copy to the page to clarify.

This documentation is versioned. Use the version control in the
upper-left of this page to select the version that matches your
Torchaudio build. The *nightly* build is the most recent--and
unstable--release.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move this to the bottom of the page?
We'd like to keep information more relevant to frequent visitors on top and one-time information like this lower.

@mthrok
Copy link
Collaborator

mthrok commented Mar 6, 2023

I am not sure the effectiveness of this approach.
I think what we should do is to either warn readers on all the pages like done in boost https://www.boost.org/doc/libs/1_79_0/
or old Python https://docs.python.org/3.6/library/index.html, or/and make the version so noticeable like currently supported Python docs does. https://docs.python.org/3/library/index.html

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

Successfully merging this pull request may close these issues.

None yet

3 participants