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

Incorrect link on docs #2380

Open
diegozea opened this issue Feb 19, 2024 · 4 comments
Open

Incorrect link on docs #2380

diegozea opened this issue Feb 19, 2024 · 4 comments

Comments

@diegozea
Copy link
Contributor

Hi!

I am trying to learn to use Flux, and I found this link error in the tutorial: https://fluxml.ai/Flux.jl/stable/tutorials/logistic_regression/#Dataset
In particular, "(see Performance tips)" links to https://fluxml.ai/Flux.jl/stable/tutorials/logistic_regression/tutorials/@ref%20man-performance-tips instead of linking to https://fluxml.ai/Flux.jl/stable/performance/#[Performance-Tips]((@id-man-performance-tips))

I haven't tested, but could it be a more general problem due to a re-organization of the docs?

Cheers,

@ToucheSir
Copy link
Member

I don't think so, the @ref just needs to be toid-man-performance-tips instead of man-performance-tips. Either something changed with how Documenter.jl handles section title names, or the original page had a typo.

diegozea added a commit to diegozea/Flux.jl that referenced this issue Feb 28, 2024
@diegozea
Copy link
Contributor Author

@CarloLucibello, it looks like the issue was not solved. The link is going to https://fluxml.ai/Flux.jl/dev/tutorials/logistic_regression/tutorials/@ref%20id-man-performance-tips (404 error).

@ToucheSir ToucheSir reopened this Feb 29, 2024
@darsnack
Copy link
Member

darsnack commented Mar 9, 2024

Why not just do @ref "Performance tips" which is the Documenter default?

@ToucheSir
Copy link
Member

I wasn't aware that syntax worked, worth a try!

isentropic pushed a commit to isentropic/Flux.jl that referenced this issue Mar 13, 2024
@ToucheSir ToucheSir linked a pull request Oct 14, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants