Fix broken internal links across 4 files (DOCT-2624) - #1673
Conversation
- developer-tools/snyk-cli/commands/fix.md: correct install-the-snyk-cli folder name (was install-or-update-the-snyk-cli) and update two Remediation Agent links to its current location at scan-fix-and-prevent/fix/remediation-agent.md - scan-fix-and-prevent/fix/remediation-agent.md: same install folder name fix (two occurrences) - snyk-data-and-governance/.gitbook/includes/release-status-snyk-code-local-engine.md: fix relative path depth (../../ -> ../../../) to reach discover-snyk/ - scan-fix-and-prevent/.gitbook/includes/release-status-snyk-code-local-engine.md: replace raw GitHub URL with correct relative path Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
VeronicaSnyk
left a comment
There was a problem hiding this comment.
Staff tech writer review
Approving. All five link corrections resolve, all four original links were genuinely broken, and the PR leaves no stale references behind. No style or structural findings — the diff touches link targets only and does not alter prose.
What I verified
Every changed link resolves. I resolved each relative path arithmetically against the branch tree rather than eyeballing the ../ counts:
| Source | Resolved target | Result |
|---|---|---|
commands/fix.md |
developer-tools/snyk-cli/install-the-snyk-cli |
OK |
commands/fix.md (×2) |
scan-fix-and-prevent/fix/remediation-agent.md |
OK |
fix/remediation-agent.md (×2) |
developer-tools/snyk-cli/install-the-snyk-cli |
OK |
| both include files | discover-snyk/getting-started/snyk-release-process.md |
OK |
All four original links were genuinely broken — confirmed each old target is absent from the tree, so every change is justified rather than cosmetic.
The ../../../ depth is correct for both include files. Both sit at <section>/.gitbook/includes/ (three segments deep), so ../../ resolved to <section>/discover-snyk/... — which does not exist. The two files are now byte-identical, which is right since they are copies of the same include.
No stale references remain repo-wide. Code search returns 0 hits for both agent-security/remediation-agent and install-or-update-the-snyk-cli, and agent-security/ no longer contains a Remediation Agent page. The move is complete.
Link targets are canonical. Cross-checked against the whole published corpus: the Remediation Agent lives at scan-fix-and-prevent/fix/remediation-agent, and the CLI install page is titled Install the Snyk CLI. Nothing elsewhere in the docs contradicts either target.
One note, not a blocker
developer-tools/snyk-cli/commands/fix.md 404s at the URL derived from its repo path, but it is published — at developer-tools/snyk-cli/snyk-cli/commands/fix, with a doubled snyk-cli segment. 125 CLI pages publish under that doubled segment, so this is how the CLI subtree is laid out, not a problem with this PR. Flagging it only so it is not mistaken for a broken page in a future link scan.
Test plan item 2 (re-run check_external_links.py, confirm 11 broken .md entries drop to 0) is worth completing after merge, since this PR fixes 5 of them and the remaining 6 are presumably in other files.


Summary
developer-tools/snyk-cli/commands/fix.md: corrects install folder name (install-the-snyk-cli, notinstall-or-update-the-snyk-cli) and updates two Remediation Agent links to its current location atscan-fix-and-prevent/fix/remediation-agent.mdscan-fix-and-prevent/fix/remediation-agent.md: same install folder name fix (two occurrences)snyk-data-and-governance/.gitbook/includes/release-status-snyk-code-local-engine.md: fixes relative path depth (../../→../../../) to correctly reachdiscover-snyk/scan-fix-and-prevent/.gitbook/includes/release-status-snyk-code-local-engine.md: replaces raw GitHub blob URL with a correct relative pathThese were identified by the recurring broken-link scan (DOCT-2624). External 4xx links are tracked separately and are not included here.
Test plan
check_external_links.pyafter merge and confirm the 11 broken .md entries drop to 0Note
Low Risk
Documentation-only link corrections with no code, authentication, or data-handling impact.
Overview
Fixes broken internal relative links across four documentation files.
Updates Snyk CLI install page references from the old
install-or-update-the-snyk-clipath toinstall-the-snyk-cliinfix.mdandremediation-agent.md. Corrects Remediation Agent cross-references to point toscan-fix-and-prevent/fix/remediation-agent.md. Also fixes relative path depth in two release-status include files so the Snyk Release Process link resolves correctly, replacing one raw GitHub blob URL with a relative path.Reviewed by Cursor Bugbot for commit c2eba05. Bugbot is set up for automated code reviews on this repo. Configure here.