-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
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
"These docs are out of date!" banner support for older docs pages #2432
Comments
@anshulrgoyal In the context of a docusaurus site, this is one possible layout: |
Having this in the docs layout could be a problem in some cases. For example a doc in v1 might be deleted/renamed in v2, so it's not possible to go to the same doc in v2. This makes more sense to me if this is a global warning. |
Yeah it will be a global warning |
@anshulrgoyal Alternatively, we can use a banner so it is clearer that it is a global warning |
BannerWhen the user clicks on banner it will take to
BreadcrumbsWhen the user clicks on breadcrumbs it will take to
|
Prefer not to use a global warning because there's already the announcement bar. We don't want to have so many "announcements". Adding global UI items has already been a cause of layout pain because the navbar can be fixed (you can look at how much code @lex111 added to support the announcement bar) and I don't think we should contribute to it even further. |
We will be moving forward with breadcrumbs option. |
🚀 Feature
A configurable banner that shows at the top of all versioned docs, directing people to the most recent page.
Have you read the Contributing Guidelines on issues?
Sure have :)
Motivation
On ReactNative.dev, 3.5% of traffic is to versioned docs. Sometimes search engines mess up (don't we all?) and show old pages to users looking for the most up-to-date information. Sometimes they don't even realize that they're looking at old information! Wouldn't be nice to let those 3.5% users know where they are and give them a link to the latest docs.
This is a technique other documentation sites take when they still want their older docs to be indexable and searchable, but they don't want users to be mislead!
Pitch
When a user visits a versioned doc, across the top of the page, show them a sticky banner that tells them:
The text was updated successfully, but these errors were encountered: