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

Consider adjusting processes to ensure docs are current on RTD's stable #19835

Open
markcmiller86 opened this issue Sep 19, 2024 · 0 comments
Open
Labels
docs update to the documentation

Comments

@markcmiller86
Copy link
Member

markcmiller86 commented Sep 19, 2024

Describe what needs to be documented.

RTD defines a stable view of the docs which is the most up to date release from GitHub. Its possible to hide RTD's stable docs but that winds up disabling warning features in hosted docs that warn users when they are looking at a version other than the most recent release.

However, after a year or more work making several releases from an RC branch, if all doc updates go to develop, they won't appear in RTD's stable for that entire time.

Should we adopt a new practice of doing doc updates both on RC and develop to avoid the long delays in documentation appearing on RTD's stable?

So far, we have one "user" that ran into this. @JustinPrivitera suggests we wait to decide this until we encounter another user using stable.

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

No branches or pull requests

1 participant