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 warning for outdated docs #3907

Closed
fingolfin opened this issue Jul 3, 2024 · 3 comments
Closed

Add warning for outdated docs #3907

fingolfin opened this issue Jul 3, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@fingolfin
Copy link
Member

Julia docs show a big red banner "This documentation is not for the latest version. Go to the latest documentation." on pages like https://docs.julialang.org/en/v1.7/

We should do the same for the OSCAR docs (and ideally also AA, Nemo, Hecke, etc.)

@thofma pointed out on Slack that JuliaDocs/Documenter.jl#1577 is relevant and that there is a script to add it to old documentation.

@lgoettgens added that on newer outdated pages like https://docs.oscar-system.org/v1.0/ the banner is already there. So it just remains to run DocumenterTools.OutdatedWarning.generate once per repository on the gh-pages branch

It remains for someone to tackle this -- perhaps @aaruni96 can have a look.

@lgoettgens
Copy link
Member

I now added PRs to all of our repositories with the script changes, apart from Hecke. The script does not like the current Vitepress site there and is thus unable to determine the point in time when the warning was added already at release. This would need some more manual work.

@fingolfin
Copy link
Member Author

Very nice, thank you @lgoettgens !

@lgoettgens
Copy link
Member

Closing in favor of thofma/Hecke.jl#1590, since this issue is no longer relevant for Oscar.

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