Fix broken external links in docs#310
Conversation
Fix 13 broken external links found by the broken-link checker: - Update Warp client LICENSE links (10 files) from the non-existent blob/master/LICENSE to blob/master/LICENSE-AGPL, the actual AGPL v3 license file in warpdotdev/warp. - Fix cross-space links that incorrectly included the /warp prefix (docs/warp is the docs homepage, so "warp" is omitted from URLs): - docs.warp.dev/warp/code/code-editor -> docs.warp.dev/code/code-editor - docs.warp.dev/warp/terminal/settings -> docs.warp.dev/terminal/settings - Point the third-party CLI agents link to the concrete overview page (agent-platform/cli-agents/overview). The two remaining reported 403s (help.openai.com, tiktok.com) are bot protection false positives; both pages exist when visited normally. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
This PR fixes broken and non-canonical external links across 13 documentation pages. It updates the open-source license link from .../blob/master/LICENSE to .../blob/master/LICENSE-AGPL in 10 files, canonicalizes three cross-space docs.warp.dev/warp/... links (in codebase-context.md and slash-commands.md), and points the Claude Code migration page at agent-platform/cli-agents/overview instead of the agent-platform/cli-agents index. Every changed line is correct.
Verification: warpdotdev/warp no longer has a plain LICENSE file (it now has LICENSE-AGPL and LICENSE-MIT), so the old link 404s and LICENSE-AGPL returns 200 — and AGPL is the right target since the docs describe the client as "AGPL v3". The agent-platform/cli-agents index is a genuine 404 while .../cli-agents/overview returns 200. The /warp/... links 308-redirect to their canonical /code/... and /terminal/... targets (all target files exist locally), so they weren't hard-broken, but removing the warp prefix matches the repo's own convention that docs/warp/ is the homepage. The internal link checker passes cleanly (0 broken across 1743 internal links / 260 files), and no SUMMARY.md or .gitbook.yaml redirect changes are needed since no files were moved or renamed.
One consistency gap: codebase-context.md (a file this PR edits) still has a non-canonical /warp/code/git-worktrees link on line 34, outside the edited hunk. A few out-of-scope files also still contain redirecting /warp/... links (interactive-code-review.md, agent-context/README.md, and several guides/* pages) if a follow-up canonicalization pass is desired — none are hard-broken since they redirect.
Found: 0 critical, 0 important, 1 suggestion, 0 nits. Recommendation: Approve.
| * **[File Tree](https://docs.warp.dev/warp/code/code-editor/file-tree)** - Browse your project structure in Warp's sidebar and open files directly. | ||
| * **[Code editor](https://docs.warp.dev/warp/code/code-editor)** - Edit files with syntax highlighting, LSP support, and find-and-replace without leaving Warp. | ||
| * **[File Tree](https://docs.warp.dev/code/code-editor/file-tree)** - Browse your project structure in Warp's sidebar and open files directly. | ||
| * **[Code editor](https://docs.warp.dev/code/code-editor)** - Edit files with syntax highlighting, LSP support, and find-and-replace without leaving Warp. |
There was a problem hiding this comment.
💡 [SUGGESTION] Good canonicalization of these two links. Since this PR is removing the /warp/ prefix from cross-space links, consider fixing the remaining one in this same file on line 34:
[Git worktree](https://docs.warp.dev/warp/code/git-worktrees) → [Git worktree](https://docs.warp.dev/code/git-worktrees)
It currently 308-redirects (so it's not hard-broken), but per the repo's link convention docs/warp/ is the docs homepage, so warp shouldn't appear in the URL. Fixing it here keeps this page internally consistent.
1 participant
Summary
Fixes 13 broken external links surfaced by the
check_for_broken_linksskill (down from 15 findings to 2 confirmed false positives).Changes
github.com/warpdotdev/warp/blob/master/LICENSEreturned 404. The AGPL v3 license file on the repo's default (master) branch isLICENSE-AGPL, so all references now point toblob/master/LICENSE-AGPL./warpprefix, sincedocs/warp/is the docs homepage and "warp" is omitted from published URLs:docs.warp.dev/warp/code/code-editor→docs.warp.dev/code/code-editor(also the adjacent/file-treesubpage link)docs.warp.dev/warp/terminal/settings→docs.warp.dev/terminal/settingsdocs.warp.dev/agent-platform/cli-agents(404) now targets the concretecli-agents/overviewpage.Not changed (false positives)
The two remaining reported
403s are bot protection, not broken links:help.openai.com/en/articles/4936856-understanding-tokens— Cloudflare-protected; the article exists.tiktok.com/@warp.dev— returns200with a normal browser user agent.Verification
200.Note on base branch
The working checkout tracks the archived
warpdotdev/gitbookrepo, whose history has no common ancestor withwarpdotdev/docsmain. To keep this PR reviewable, it targetsbroken-links-base(the pre-fix gitbook snapshot) so the diff shows only the link fixes.Conversation: https://app.warp.dev/conversation/a3b97032-ae12-4a4c-b0a3-45a86e157508
Run: https://oz.warp.dev/runs/019f47d2-7c40-7766-862e-7382b083b3fe
This PR was generated with Oz.