Fix broken external links in docs#320
Conversation
- Update GitHub LICENSE links from master to main branch (10 files) - Drop incorrect /warp prefix from docs.warp.dev self-links - Point CLI agents link to cli-agents/overview landing page 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 correctly fixes 13 broken external links: 10 GitHub LICENSE links updated from master to main, two docs.warp.dev self-links with an incorrect /warp prefix removed, and one CLI agents link corrected to point at /agent-platform/cli-agents/overview. The internal link checker confirms 0 broken internal links after the fix, and all corrected destination paths exist in the docs structure. However, contributing.md has four additional GitHub links still pointing to the master branch that were missed — the CONTRIBUTING.md link on the same changed line (line 10), plus CONTRIBUTING.md and CODE_OF_CONDUCT.md links on lines 15, 40, and 44. Found: 1 critical, 0 important, 0 suggestions, 0 nits. Request changes.
There was a problem hiding this comment.
🚨 [CRITICAL] The LICENSE link on this line was correctly updated to main, but the CONTRIBUTING.md link at the end of the same line still points to master and is likely also 404.
The same file has three more missed master links outside this diff hunk:
- Line 15:
[`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md) - Line 40:
[`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md#reporting-security-issues) - Line 44:
[full text](https://github.com/warpdotdev/warp/blob/master/CODE_OF_CONDUCT.md)
All four should use main instead of master. Fixing line 10 here:
Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/main/CONTRIBUTING.md).
| # Contributing to Warp | ||
|
|
||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/master/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). | ||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). |
There was a problem hiding this comment.
🚨 [CRITICAL] The LICENSE link on this line was correctly updated to main, but the CONTRIBUTING.md link at the end of the same line still points to master and is likely also 404.
The same file has three more missed master links outside this diff hunk:
- Line 15:
[`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md) - Line 40:
[`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md#reporting-security-issues) - Line 44:
[full text](https://github.com/warpdotdev/warp/blob/master/CODE_OF_CONDUCT.md)
All four should use main instead of master. Fixing line 10 here:
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). | |
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/main/CONTRIBUTING.md). |
There was a problem hiding this comment.
This PR correctly fixes 13 broken external links: 10 GitHub LICENSE links updated from master to main, two docs.warp.dev self-links with an incorrect /warp prefix removed, and one CLI agents link corrected to point at /agent-platform/cli-agents/overview. The internal link checker confirms 0 broken internal links after the fix, and all corrected destination paths exist in the docs structure. However, contributing.md has four additional GitHub links still pointing to the master branch that were missed — the CONTRIBUTING.md link on the same changed line (line 10), plus CONTRIBUTING.md and CODE_OF_CONDUCT.md links on lines 15, 40, and 44. Found: 1 critical, 0 important, 0 suggestions, 0 nits. Request changes.
| # Contributing to Warp | ||
|
|
||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/master/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). | ||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). |
There was a problem hiding this comment.
🚨 [CRITICAL] The LICENSE link on this line was correctly updated to main, but the CONTRIBUTING.md link at the end of the same line still points to master and is likely also 404.
The same file has three more missed master links outside this diff hunk:
- Line 15:
[`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md) - Line 40:
[`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md#reporting-security-issues) - Line 44:
[full text](https://github.com/warpdotdev/warp/blob/master/CODE_OF_CONDUCT.md)
All four should use main instead of master. Fixing line 10 here:
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). | |
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/main/CONTRIBUTING.md). |
There was a problem hiding this comment.
@oz-agent are you sure this is correct?
There was a problem hiding this comment.
I'm working on changes requested in this PR (responding to an inline review-thread comment).
You can view the conversation on Warp.
I pushed changes to this PR based on the comment.
Next steps:
- Review the changes pushed to this PR.
- Follow up with another comment if further adjustments are needed.
Powered by Oz
There was a problem hiding this comment.
@hongyi-chen: All 10 files are corrected. The CONTRIBUTING.md and CODE_OF_CONDUCT.md links (already on master) I left untouched since they're valid on master. Here's my answer to the question.
No — you were right to question it. The master → main change was not correct, even though the resulting link happens to return 200.
What's actually going on
I checked the live warpdotdev/warp repo (via gh api and raw fetches):
- The default branch is
master, notmain.mainis a stale, renamed branch — GitHub currently 302-redirectsmain→old-main. - The AGPL license file on
masteris namedLICENSE-AGPL, notLICENSE. That's the real reasonblob/master/LICENSEreturned 404 — the file was renamed, not moved to a different branch. blob/main/LICENSEreturns 200 only by accident: themain→old-mainrename redirect lands on an outdated branch that still contains an oldLICENSEfile. That's fragile (it depends on a temporary branch-rename redirect to a stale branch) and points at outdated source.
Verified status codes:
master/LICENSE→ 404master/LICENSE-AGPL→ 200 ✅ (correct target)main/LICENSE→ 200 only via redirect toold-main(stale)master/CONTRIBUTING.md→ 200,master/CODE_OF_CONDUCT.md→ 200 (these were correct as-is)
What I changed
I corrected the license link to the canonical target on the default branch across all 10 affected files:
https://github.com/warpdotdev/warp/blob/main/LICENSE → https://github.com/warpdotdev/warp/blob/master/LICENSE-AGPL
Files updated: contributing.md, enterprise/README.md, security-overview.md, warp/README.md, customizing-warp.md, installation-and-setup.md, agent-platform/README.md, agent-platform/warp-agents/README.md, pricing-faqs.md, and privacy.md.
A note on the earlier review comment
An earlier review suggested there were "4 missed master → main" links in this file (the CONTRIBUTING.md and CODE_OF_CONDUCT.md links on lines 10, 15, 40, and 44). That premise was wrong: those files exist on master but not on main/old-main, so switching them to main would have broken them. I intentionally left them on master.
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR updates broken external documentation links by moving Warp GitHub LICENSE links from master to main, removing stale /warp prefixes from docs self-links, and pointing the CLI agents link at its overview page. The diff is documentation-only, with no security-sensitive code or configuration changes. spec_context.md reports that no approved or repository spec context was found, so there are no spec commitments to compare against.
Concerns
- One changed line still contains a
github.com/warpdotdev/warp/blob/master/...link. Since the PR states the branch is nowmain, this likely leaves a broken external link in the same file being edited.
Verdict
Found: 0 critical, 1 important, 0 suggestions
Request changes
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
| # Contributing to Warp | ||
|
|
||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/master/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). | ||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). |
There was a problem hiding this comment.
CONTRIBUTING.md through blob/master, so the PR likely leaves another GitHub 404 behind; update it to blob/main as well.
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). | |
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/main/CONTRIBUTING.md). |
There was a problem hiding this comment.
This PR correctly fixes 13 broken external links across 13 files: 10 GitHub LICENSE links updated from master to main branch (verified the master URL returns 404), two docs.warp.dev self-links with an incorrect /warp prefix, and one CLI agents landing page link that had no index page. The internal link checker confirms 0 broken internal links after these changes. Changes are minimal, accurate, and scoped — no style or structure issues. Found: 0 critical, 0 important, 1 suggestion, 0 nits. Approve.
| # Contributing to Warp | ||
|
|
||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/master/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). | ||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/master/LICENSE-AGPL) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). |
There was a problem hiding this comment.
💡 [SUGGESTION] The LICENSE link in this sentence was updated from master to main (good fix), but the CONTRIBUTING.md link in the same sentence still points to master. Both CONTRIBUTING.md and CODE_OF_CONDUCT.md (line 44) also still reference master. Those links currently return HTTP 200 so they aren't broken today, but updating them to main would make the file consistent and more resilient if the master branch redirect is ever removed.\n\nsuggestion\nWarp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/main/CONTRIBUTING.md).\n
There was a problem hiding this comment.
This PR correctly fixes 13 broken external links across 13 files: 10 GitHub LICENSE links updated from master to main branch (verified the master URL returns 404), two docs.warp.dev self-links with an incorrect /warp prefix, and one CLI agents landing page link that had no index page. The internal link checker confirms 0 broken internal links after these changes. Changes are minimal, accurate, and scoped — no style or structure issues. Found: 0 critical, 0 important, 1 suggestion, 0 nits. Approve.
| # Contributing to Warp | ||
|
|
||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/master/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). | ||
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). |
There was a problem hiding this comment.
💡 [SUGGESTION] The LICENSE link in this sentence was updated from master to main (good fix), but the CONTRIBUTING.md link in the same sentence still points to master. Both CONTRIBUTING.md and CODE_OF_CONDUCT.md (line 44) also still reference master. Those links currently return HTTP 200 so they aren't broken today, but updating them to main here would make the file consistent and more resilient if the master branch redirect is ever removed.
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/master/CONTRIBUTING.md). | |
| Warp's client is open source under [AGPL v3](https://github.com/warpdotdev/warp/blob/main/LICENSE) at [`warpdotdev/warp`](https://github.com/warpdotdev/warp), and there's room for every kind of contribution — from a one-line bug report to a full feature PR, a new theme, or a workflow that ships to every Warp user. For the full code contribution flow, see [`CONTRIBUTING.md`](https://github.com/warpdotdev/warp/blob/main/CONTRIBUTING.md). |
2 participants
Summary
Fixes broken external links found by the
check_for_broken_linksskill scan of the docs source.The internal link check passed with 0 broken links (1743 checked). The external scan surfaced 15 broken links; 13 were real and are fixed here, and 2 are false positives (bot-blocked but valid for humans, verified with a browser user-agent).
Fixes
github.com/warpdotdev/warp/blob/master/LICENSEreturned 404 because the branch is nowmain. Updatedmaster→main.docs.warp.devself-links with an incorrect/warpprefix (thewarp/folder is the docs homepage, so it is not part of the URL):agent-platform/warp-agents/codebase-context.md:/warp/code/code-editor→/code/code-editor(and the neighboring File Tree link for consistency)agent-platform/warp-agents/slash-commands.md:/warp/terminal/settings→/terminal/settingswarp/getting-started/migrate-to-warp/migrate-to-warp-from-claude-code.md:/agent-platform/cli-agents(no landing page, 404) →/agent-platform/cli-agents/overview.Not changed (verified false positives)
https://help.openai.com/en/articles/4936856-understanding-tokens— HTTP 403 (Cloudflare bot protection; valid for humans).https://www.tiktok.com/@warp.dev— HTTP 403 to bots; returns 200 with a browser user-agent.Verification
Re-ran the external link check after fixes: only the 2 known false positives remain.
Conversation: https://app.warp.dev/conversation/fa5c6325-724a-40c8-ac35-5652c76fbf21
Run: https://oz.warp.dev/runs/019f4b41-647f-75c6-8a52-baabba614637
This PR was generated with Oz.