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

docs: add references to stable and latest docs versions #748

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

edibotopic
Copy link
Contributor

The authd docs now include stable and latest versions.
The stable points to that last tagged release (excluding alphas and betas) and is the default.
The latest points to the last commit in the main branch and can be toggled in the dialog on the bottom right of each page:

image

Helpfully, when a user switches to latest, Read the Docs shows a notification that some features that are documented may not be available in the stable release:

image

Despite these affordances, it is still a good idea to mention explicitly that there are two versions of the docs, providing links where appropriate.

Main changes here are:

  • updating README docs links to include stable and latest
  • adds comment on docs versions to README and docs homepage
  • adds comment on latest docs in troubleshooting section that mentions using edge release

UDENG-5737

* updates README docs links to include stable and latest
* adds comment on docs versions to homepage
* adds comment on latest docs in troubleshooting section mentioning edge
@edibotopic edibotopic marked this pull request as ready for review January 22, 2025 14:45
@edibotopic edibotopic requested a review from a team as a code owner January 22, 2025 14:45
@edibotopic edibotopic requested a review from adombeck January 22, 2025 14:45
@3v1n0
Copy link
Collaborator

3v1n0 commented Jan 22, 2025

Lovely!

@3v1n0 3v1n0 merged commit 7afe951 into main Jan 22, 2025
11 checks passed
@3v1n0 3v1n0 deleted the doc-versions-stable-latest branch January 22, 2025 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants