From d2e5e3d99ccfe755bc389ef496ebdee8c638ba48 Mon Sep 17 00:00:00 2001 From: HiDeoo <494699+HiDeoo@users.noreply.github.com> Date: Mon, 18 Nov 2024 16:20:48 +0100 Subject: [PATCH] docs: update link check instructions --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33cd9c7e8f1..e6541d9c0c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,11 +121,11 @@ You should then be able to open and see your changes. When adding or translating content in the Starlight docs site, you can check all internal links are valid. All GitHub PRs are checked this way automatically, but testing locally can help if you want to confirm changes are correct before committing them. -To do this, move into the `docs/` directory from the root of the repo and then build the site with the `CHECK_LINKS` environment variable: +To do this, move into the `docs/` directory from the root of the repo and then run `pnpm linkcheck`: ```sh cd docs -CHECK_LINKS=true pnpm build +pnpm linkcheck ``` If there are any broken links, the build will fail and log which pages need to be fixed.