Documenter.jl icon indicating copy to clipboard operation
Documenter.jl copied to clipboard

Clicking on another docs version should point to the equivalent page

Open jtrakk opened this issue 4 years ago • 4 comments

If I'm on the v1.5 Filesystem docs and I click on the v1.6 link in the bottom-left corner, it goes to the home page https://docs.julialang.org/en/v1.6/, not the Filesystem page, which is annoying. I want to go to the equivalent page of the other version.

@fredrikekre says

For the Julia manual you should always be on the v1 version though, it is valid for all of Julia 1.X.

The v1 version differs from earlier versions in some ways, like including methods that don't exist in earlier versions and will confuse earlier readers. Also reading the next (prerelease) version's docs may show what is coming soon.

jtrakk avatar Jun 30 '21 19:06 jtrakk

The v1 version differs from earlier versions in some ways, like including methods that don't exist in earlier versions and will confuse earlier readers.

Do you have any examples? Those should all have compat annotations.

fredrikekre avatar Jun 30 '21 19:06 fredrikekre

I see, not as confusing as I thought then. Still it would be nice to have.

jtrakk avatar Jun 30 '21 19:06 jtrakk

Yea, I guess it can be on a "best-effort" since it can't be guaranteed that the same page exist on the other version.

fredrikekre avatar Jun 30 '21 19:06 fredrikekre

I think it should be possible to check in the browser if the URL in the other version 404-s or not, and decide based on that.

mortenpi avatar Jul 19 '21 05:07 mortenpi

Closing as a duplicate of https://github.com/JuliaDocs/Documenter.jl/issues/858

odow avatar Nov 01 '23 01:11 odow