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

Archive documentation should have a banner that say that this is not the lastest doc #5020

Open
ogoffart opened this issue Apr 5, 2024 · 0 comments
Labels
a:documentation Improvements or additions to documentation (infrastructure and text itself) (mS,bT) enhancement New feature or request

Comments

@ogoffart
Copy link
Member

ogoffart commented Apr 5, 2024

Many users can get confused when looking old documentation, and not realize it is an outaded docs.
(example #5019)

We should inject a banner somehow in the HTML of these old documentation.

The banner would just be a warning that this is an old version, maybe with a link to the new version.
We could also have a combo-box to switch version like cmake does (example from cmake: https://cmake.org/cmake/help/v3.24/command/file.html ).

I recommend that we run a command line to add a <script> to every file within the right directory of the www-releases repo.
Example (untested): find . -name "*.html" -exec sed -i '/<\/head>/i <script src="..."></script>' {} \;

But for future version we can also add the script directly before.

@ogoffart ogoffart added a:documentation Improvements or additions to documentation (infrastructure and text itself) (mS,bT) enhancement New feature or request labels Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:documentation Improvements or additions to documentation (infrastructure and text itself) (mS,bT) enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant