diff --git a/docs/README.md b/docs/README.md index 5f0d62dfc1f..3f112e59005 100644 --- a/docs/README.md +++ b/docs/README.md @@ -81,7 +81,7 @@ From the root of the repo: make check-docs-link ``` -This command will run `lychee` (if you don't have it, see the [install docs](https://lychee.cli.rs/installation/)) and check all links in `./docs/docs` (i.e. it will not check versioned docs). +This command will run `lychee` (if you don't have it, see the [install docs](https://lychee.cli.rs/guides/getting-started/)) and check all links in `./docs/docs` (i.e. it will not check versioned docs). Since a lot of our links are to github, this command easily gets rate limited, so it has been set up with a long retry sequence for links. You may need to run it multiple times to check all links. The results (except rate limit responses) are cached for 1 week, so once you have run it, it will not keep checking the same links twice (this is primarly to help with rate limiting).