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

Add notification in ReadtheDocs if displaying the latest version #175

Open
cr-xu opened this issue Jun 14, 2024 · 1 comment
Open

Add notification in ReadtheDocs if displaying the latest version #175

cr-xu opened this issue Jun 14, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@cr-xu
Copy link
Member

cr-xu commented Jun 14, 2024

Users should receive notification if they are viewing the doc page of an older version or the latest (probably unstable) version from main branch.

This would prevent people from getting confused like #174.

@jank324 I think this can be configured by admin in RTD (c.f. https://docs.readthedocs.io/en/stable/versions.html#version-warning)?

@cr-xu cr-xu added the documentation Improvements or additions to documentation label Jun 14, 2024
@jank324
Copy link
Member

jank324 commented Jun 15, 2024

I've activated the notification.

I've also built a special v0.6.3 docs, but that's currently identical to stable.

I also realised, we can change which docs are shown by default. This is currently set to latest, which builds directly from the master branch. We could think about if it should point to stable instead, which builds from the last release.

However, the confusion in #174 didn't actually result from the docs. Funnily enough, @Hespe ran into exactly the same issue just the day before 😄. In both cases, they saw the code example that you see first when finding Cheetah on GitHub ... which is on the current master branch, but they had the most recent release installed. While notifying people in the docs is a good idea, this wouldn't have prevented either confusion. This is also a unique situation right now, where the code example isn't compatible with both the latest release and the master branch. We haven't really been in this situation before and we are unlikely to be in it again. So maybe the solution here is just to release v0.7 soon (#165).

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