Zulip Chat Archive

Stream: general

Topic: mathlib3 docs have no warning


Kevin Buzzard (Jun 28 2024 at 18:55):

It was just pointed out to me that
a) if you go to google and search for mathlib documentation then the top link is the mathlib3 page https://leanprover-community.github.io/mathlib_docs/index.html

b) This page gives no indication that mathlib3 is deprecated and it's almost certain that you're in the wrong place.

How do I go about fixing this?

Bryan Gin-ge Chen (Jun 28 2024 at 20:11):

Perhaps adding some suitable warning text here to the header in doc-gen3 will be enough?

Bryan Gin-ge Chen (Jun 28 2024 at 20:12):

If you submit a PR I can check and deploy it when I have a chance.

Kevin Buzzard (Jun 28 2024 at 20:21):

That will only change the top line of the web page, right?

Where is the line that says "Welcome to mathlib 3's documentation page" stored? I think it should say "WARNING: this is the mathlib 3 documentation page. Mathlib3 is no longer maintained, and you probably want the <mathlib4 page>(link)"

Eric Wieser (Jun 28 2024 at 20:22):

Here: https://github.com/leanprover-community/doc-gen/blob/0ab85f2ad359ecb52311f31bbf61ea9cf60ffb4c/templates/index.j2

Bryan Gin-ge Chen (Jun 28 2024 at 20:23):

Eric beat me to the index template link which should be fixed as well, but my hope is that changing the header will make the warning show up on every doc page.

Bhavik Mehta (Jun 29 2024 at 13:59):

I think it would be super useful if those pages linked to the relevant mathlib4 doc page, if that's feasible to do.

Eric Wieser (Jun 29 2024 at 21:46):

In theory we can do that with the align data, but that's much more work that what Kevin suggests, and the two are orthogonal


Last updated: May 02 2025 at 03:31 UTC