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

Link in README broken #506

Open
1 task done
BSchilperoort opened this issue Nov 22, 2024 · 0 comments
Open
1 task done

Link in README broken #506

BSchilperoort opened this issue Nov 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@BSchilperoort
Copy link

Wflow version checks

  • I have checked that the issue still exists on the latest versions of the docs on master here

Kind of issue

Docs are wrong

Location of the documentation

README.md

Documentation problem

Installation
For the installation enter the Pkg REPL by pressing ] from the Julia REPL, and then
pkg> add Wflow
A more detailed description, including a development install, is available here.

links to "https://deltares.github.io/Wflow.jl/dev/user_guide/install", however that page returns 404

Suggested fix for documentation

Possibly update the link to https://deltares.github.io/Wflow.jl/dev/getting_started/install.html, or point to stable instead https://deltares.github.io/Wflow.jl/stable/user_guide/install/

It is also possible to use a markdown link checker to ensure links stay alive, but they also have downsides (false positives etc.).

@BSchilperoort BSchilperoort added the documentation Improvements or additions to documentation label Nov 22, 2024
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

1 participant