was skipped and the guard passed a README that GitHub renders with a broken image.
Regression test fails without the parser change.
---
.github/workflows/pr.yml | 6 +
README.md | 16 +-
config/scripts/check-readme-local-links.mjs | 102 ++++++++++++
.../scripts/check-readme-local-links.test.mjs | 156 ++++++++++++++++++
config/scripts/vendor-feature-wall-assets.mjs | 4 +-
docs/assets/agent-statuses.gif | Bin 1321859 -> 0 bytes
docs/assets/annotate-ai-diff.gif | Bin 202053 -> 0 bytes
docs/assets/caffeinate-agent-menu-after.png | Bin 12202 -> 0 bytes
docs/assets/caffeinate-agent-menu-before.png | Bin 14078 -> 0 bytes
docs/assets/codex-account-switcher.gif | Bin 395543 -> 0 bytes
docs/assets/feature-wall/annotate-diff.gif | Bin 202053 -> 0 bytes
docs/assets/feature-wall/annotate-diff.jpg | Bin 74091 -> 0 bytes
docs/assets/feature-wall/cli-agents.gif | Bin 210479 -> 0 bytes
docs/assets/feature-wall/cli-agents.jpg | Bin 45077 -> 0 bytes
docs/assets/feature-wall/codex-accounts.gif | Bin 395543 -> 0 bytes
docs/assets/feature-wall/codex-accounts.jpg | Bin 14546 -> 0 bytes
docs/assets/feature-wall/design-mode.gif | Bin 2052927 -> 0 bytes
docs/assets/feature-wall/design-mode.jpg | Bin 76792 -> 0 bytes
docs/assets/feature-wall/file-drag.gif | Bin 1791301 -> 0 bytes
docs/assets/feature-wall/file-drag.jpg | Bin 112273 -> 0 bytes
docs/assets/feature-wall/github-linear.gif | Bin 1794243 -> 0 bytes
docs/assets/feature-wall/github-linear.jpg | Bin 119976 -> 0 bytes
docs/assets/feature-wall/keyboard-native.gif | Bin 1953601 -> 0 bytes
docs/assets/feature-wall/keyboard-native.jpg | Bin 18034 -> 0 bytes
docs/assets/feature-wall/markdown-editor.gif | Bin 339229 -> 0 bytes
docs/assets/feature-wall/markdown-editor.jpg | Bin 33865 -> 0 bytes
docs/assets/feature-wall/orca-cli.gif | Bin 788122 -> 0 bytes
docs/assets/feature-wall/orca-cli.jpg | Bin 16751 -> 0 bytes
.../feature-wall/parallel-worktrees.gif | Bin 743061 -> 0 bytes
.../feature-wall/parallel-worktrees.jpg | Bin 24704 -> 0 bytes
docs/assets/feature-wall/split-screen.gif | Bin 2103746 -> 0 bytes
docs/assets/feature-wall/split-screen.jpg | Bin 48705 -> 0 bytes
docs/assets/feature-wall/ssh-worktrees.gif | Bin 335998 -> 0 bytes
docs/assets/feature-wall/ssh-worktrees.jpg | Bin 31711 -> 0 bytes
docs/assets/feature-wall/terminal-splits.gif | Bin 222475 -> 0 bytes
docs/assets/feature-wall/terminal-splits.jpg | Bin 54510 -> 0 bytes
docs/assets/file-drag.gif | Bin 1791301 -> 0 bytes
docs/assets/issue-1920/fix.png | Bin 105441 -> 0 bytes
docs/assets/issue-1920/reproduction.png | Bin 103873 -> 0 bytes
docs/assets/orca-design-mode.gif | Bin 2052927 -> 0 bytes
docs/assets/orca-mobile-emulator.gif | Bin 1857518 -> 0 bytes
docs/readme/README.es.md | 16 +-
docs/readme/README.fr.md | 16 +-
docs/readme/README.ja.md | 16 +-
docs/readme/README.ko.md | 16 +-
docs/readme/README.pt.md | 16 +-
docs/readme/README.zh-CN.md | 16 +-
docs/review-evidence/pr-19217/README.md | 8 +-
docs/review-evidence/pr-19217/closed.png | Bin 105757 -> 0 bytes
docs/review-evidence/pr-19217/working.png | Bin 111788 -> 0 bytes
package.json | 3 +-
.../feature-wall/tile-01.recorded-at.json | 8 +-
52 files changed, 331 insertions(+), 68 deletions(-)
create mode 100644 config/scripts/check-readme-local-links.mjs
create mode 100644 config/scripts/check-readme-local-links.test.mjs
delete mode 100644 docs/assets/agent-statuses.gif
delete mode 100644 docs/assets/annotate-ai-diff.gif
delete mode 100644 docs/assets/caffeinate-agent-menu-after.png
delete mode 100644 docs/assets/caffeinate-agent-menu-before.png
delete mode 100644 docs/assets/codex-account-switcher.gif
delete mode 100644 docs/assets/feature-wall/annotate-diff.gif
delete mode 100644 docs/assets/feature-wall/annotate-diff.jpg
delete mode 100644 docs/assets/feature-wall/cli-agents.gif
delete mode 100644 docs/assets/feature-wall/cli-agents.jpg
delete mode 100644 docs/assets/feature-wall/codex-accounts.gif
delete mode 100644 docs/assets/feature-wall/codex-accounts.jpg
delete mode 100644 docs/assets/feature-wall/design-mode.gif
delete mode 100644 docs/assets/feature-wall/design-mode.jpg
delete mode 100644 docs/assets/feature-wall/file-drag.gif
delete mode 100644 docs/assets/feature-wall/file-drag.jpg
delete mode 100644 docs/assets/feature-wall/github-linear.gif
delete mode 100644 docs/assets/feature-wall/github-linear.jpg
delete mode 100644 docs/assets/feature-wall/keyboard-native.gif
delete mode 100644 docs/assets/feature-wall/keyboard-native.jpg
delete mode 100644 docs/assets/feature-wall/markdown-editor.gif
delete mode 100644 docs/assets/feature-wall/markdown-editor.jpg
delete mode 100644 docs/assets/feature-wall/orca-cli.gif
delete mode 100644 docs/assets/feature-wall/orca-cli.jpg
delete mode 100644 docs/assets/feature-wall/parallel-worktrees.gif
delete mode 100644 docs/assets/feature-wall/parallel-worktrees.jpg
delete mode 100644 docs/assets/feature-wall/split-screen.gif
delete mode 100644 docs/assets/feature-wall/split-screen.jpg
delete mode 100644 docs/assets/feature-wall/ssh-worktrees.gif
delete mode 100644 docs/assets/feature-wall/ssh-worktrees.jpg
delete mode 100644 docs/assets/feature-wall/terminal-splits.gif
delete mode 100644 docs/assets/feature-wall/terminal-splits.jpg
delete mode 100644 docs/assets/file-drag.gif
delete mode 100644 docs/assets/issue-1920/fix.png
delete mode 100644 docs/assets/issue-1920/reproduction.png
delete mode 100644 docs/assets/orca-design-mode.gif
delete mode 100644 docs/assets/orca-mobile-emulator.gif
delete mode 100644 docs/review-evidence/pr-19217/closed.png
delete mode 100644 docs/review-evidence/pr-19217/working.png
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
index 45a3d12c2d8..ec8aec1d130 100644
--- a/.github/workflows/pr.yml
+++ b/.github/workflows/pr.yml
@@ -276,6 +276,12 @@ jobs:
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
run: node .github/scripts/check-root-directory-entries.mjs "$BASE_SHA" "$HEAD_SHA"
+ # Why here: the READMEs embed media owned by docs/site and resources/onboarding,
+ # and the classifier skips static_analysis for docs-only diffs. This job runs
+ # on every PR and needs no install.
+ - name: Check README local links
+ run: node config/scripts/check-readme-local-links.mjs
+
typecheck:
needs: [code_paths]
if: needs.code_paths.outputs.typecheck == 'true'
diff --git a/README.md b/README.md
index 7e3540c80f1..aeb8f355450 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,7 @@ Fan one prompt across five agents, each in its own isolated git worktree — com
',
+ '",
+ '
',
+ '[Contributing](.github/CONTRIBUTING.md) [Docs](https://example.com/docs) [Top](#top)',
+ ''
+ ].join('\n'),
+ 'docs/readme/README.ja.md': [
+ '
',
+ '
'
+ })
+
+ expect(findBrokenReadmeLinks(root)).toEqual([
+ { readme: 'docs/readme/README.ja.md', target: '../../../outside.png', resolved: null }
+ ])
+ })
+
+ // Why: a single-quoted attribute is valid HTML and GitHub renders it, so a parser
+ // that only reads double quotes would pass a README with a broken image.
+ it('reports a missing target in a single-quoted attribute', () => {
+ const files = {
+ ...validReadmes,
+ 'README.md': `${validReadmes['README.md']}\n
`
+ }
+
+ expect(findBrokenReadmeLinks(makeFixture(files))).toEqual([
+ {
+ readme: 'README.md',
+ target: 'docs/assets/missing.gif',
+ resolved: 'docs/assets/missing.gif'
+ }
+ ])
+ })
+
+ // Why the ungated job: static_analysis is skipped for docs-only diffs, which is
+ // exactly the kind of PR that deletes a docs-site GIF the README embeds.
+ it('runs on every PR through the ungated guard job and in the lint script', () => {
+ const { scripts } = JSON.parse(readFileSync(path.join(projectDir, 'package.json'), 'utf8'))
+ const workflow = parse(readFileSync(path.join(projectDir, '.github/workflows/pr.yml'), 'utf8'))
+ const guardJob = workflow.jobs.root_directory_guard
+ const step = guardJob.steps.find((candidate) => candidate.name === 'Check README local links')
+
+ expect(guardJob.if).toBeUndefined()
+ expect(guardJob.needs).toBeUndefined()
+ expect(step.run).toBe('node config/scripts/check-readme-local-links.mjs')
+ expect(scripts['check:readme-local-links']).toBe(
+ 'node config/scripts/check-readme-local-links.mjs'
+ )
+ expect(scripts.lint).toContain('pnpm run check:readme-local-links')
+ })
+})
diff --git a/config/scripts/vendor-feature-wall-assets.mjs b/config/scripts/vendor-feature-wall-assets.mjs
index 7c5b8946508..b1e9b061f8f 100644
--- a/config/scripts/vendor-feature-wall-assets.mjs
+++ b/config/scripts/vendor-feature-wall-assets.mjs
@@ -20,8 +20,8 @@ const TILES = [
{
id: 'tile-01',
sourceRoot: ROOT,
- gifRelativePath: 'docs/assets/feature-wall/parallel-worktrees.gif',
- posterRelativePath: 'docs/assets/feature-wall/parallel-worktrees.jpg'
+ gifRelativePath: 'docs/site/public/docs/tab-split.gif',
+ posterRelativePath: 'docs/site/public/docs/posters/tab-split.jpg'
},
{
id: 'tile-02',
diff --git a/docs/assets/agent-statuses.gif b/docs/assets/agent-statuses.gif
deleted file mode 100644
index 26d98356197c5b82a900bbaef2bfdcfaa5e99fb3..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 1321859
zcmeEtRaYBauyzaxQb=%jmlCvi6WraQI212dpioKB;O-jS-K7og6xRw~tQ071sdC=)
zU41{|%$ke2n7P=`nptb+nLQd>>N2v9XplSb#~lC=G6#IJ0E{1p+bq-2(9qH`(*3W{
z)6xI0Fc71dn3$MZSlCDmIe8_yN$t6Lc)9t+xHV^Z1VniSC3pp;_=Lpyge3TcB>$g2
z5D-xkq7?5-g~HurY