Skip to content

feat(ci): add api-reference sync agent workflow#676

Merged
mihar-22 merged 1 commit intomainfrom
codex/workflows-api-sync-and-component-followup
Mar 2, 2026
Merged

feat(ci): add api-reference sync agent workflow#676
mihar-22 merged 1 commit intomainfrom
codex/workflows-api-sync-and-component-followup

Conversation

@mihar-22
Copy link
Copy Markdown
Member

@mihar-22 mihar-22 commented Mar 2, 2026

Adds an API-reference sync workflow that reacts to merged PRs, detects doc drift per component, and keeps one canonical issue + PR per component.

Also adds concise issue/PR templates for this flow.

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 2, 2026

Deploy Preview for vjs10-site ready!

Name Link
🔨 Latest commit 88d3d2b
🔍 Latest deploy log https://app.netlify.com/projects/vjs10-site/deploys/69a527e6508cf40008bdb24d
😎 Deploy Preview https://deploy-preview-676--vjs10-site.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 2, 2026

📦 Bundle Size Report

Package Size Diff %
@videojs/core 10.28 kB 0 B ░░░░░░░░ 0%
@videojs/element 1.60 kB 0 B ░░░░░░░░ 0%
@videojs/html 18.36 kB 0 B ░░░░░░░░ 0%
@videojs/icons 3.79 kB 0 B ░░░░░░░░ 0%
@videojs/react 14.96 kB 0 B ░░░░░░░░ 0%
@videojs/store 1.95 kB 0 B ░░░░░░░░ 0%
@videojs/utils 2.81 kB 0 B ░░░░░░░░ 0%

Total: 53.75 kB · 0 B · 0%


Entry Breakdown

Subpath sizes are the additional bytes on top of the root entry point, measured by bundling root + subpath together and subtracting the root-only size.

@videojs/core
Entry Base PR Diff %
. 4.28 kB 4.28 kB 0 B 0%
./dom 6.01 kB 6.01 kB 0 B 0%
total 10.28 kB 10.28 kB 0 B 0%
@videojs/element
Entry Base PR Diff %
. 817 B 817 B 0 B 0%
./context 823 B 823 B 0 B 0%
total 1.60 kB 1.60 kB 0 B 0%
@videojs/html
Entry Base PR Diff %
. 15.20 kB 15.20 kB 0 B 0%
./video 1.06 kB 1.06 kB 0 B 0%
./audio 1.06 kB 1.06 kB 0 B 0%
./background 1.05 kB 1.05 kB 0 B 0%
total 18.36 kB 18.36 kB 0 B 0%
@videojs/icons
Entry Base PR Diff %
./react 2.27 kB 2.27 kB 0 B 0%
./html 1.52 kB 1.52 kB 0 B 0%
total 3.79 kB 3.79 kB 0 B 0%
@videojs/store
Entry Base PR Diff %
. 1.29 kB 1.29 kB 0 B 0%
./html 468 B 468 B 0 B 0%
./react 204 B 204 B 0 B 0%
total 1.95 kB 1.95 kB 0 B 0%
@videojs/utils
Entry Base PR Diff %
./array 104 B 104 B 0 B 0%
./dom 928 B 928 B 0 B 0%
./events 227 B 227 B 0 B 0%
./function 261 B 261 B 0 B 0%
./object 119 B 119 B 0 B 0%
./predicate 265 B 265 B 0 B 0%
./string 148 B 148 B 0 B 0%
./style 185 B 185 B 0 B 0%
./time 478 B 478 B 0 B 0%
./number 158 B 158 B 0 B 0%
total 2.81 kB 2.81 kB 0 B 0%

ℹ️ How to interpret

Sizes are minified + brotli, measured with esbuild.
Package totals are computed as root size + marginal subpath costs.
Subpath marginal cost = (root + subpath bundled together) − root alone.

Icon Meaning
No change
🔺 Increased ≤ 10%
🔴 Increased > 10%
🔽 Decreased
🆕 New (no baseline)

Run pnpm size locally to check current sizes.

@mihar-22 mihar-22 changed the title feat(ci): add api-reference sync issue+PR agent workflow feat(ci): add api-reference sync agent workflow Mar 2, 2026
@mihar-22 mihar-22 marked this pull request as ready for review March 2, 2026 06:05
@mihar-22 mihar-22 merged commit 55a91b1 into main Mar 2, 2026
19 checks passed
@mihar-22 mihar-22 deleted the codex/workflows-api-sync-and-component-followup branch March 2, 2026 06:05
decepulis added a commit that referenced this pull request Mar 2, 2026
The monolithic sync job from #676 had three blind spots:

1. The prompt was ambiguous about what "drift" means — the generated
   API JSON is always fresh, but the hand-written MDX prose can go
   stale. The prompt didn't make this distinction explicit.

2. It explicitly skipped demos (`Do not request runnable
   examples/demos`), so stale code examples went undetected.

3. It only checked `site/src/content/docs/reference/` — concept pages,
   how-to guides, and READMEs that mention changed APIs were ignored.

Split into a shell-only `analyze` gate + three parallel downstream
Claude jobs, each with a narrow scope and explicit instructions:

- `reference-copy` (Opus, 20 turns): MDX prose vs generated JSON
- `reference-demos` (Sonnet, 14 turns): demo code drift, issues only
- `cross-site-refs` (Sonnet, 14 turns): stale API mentions outside
  /reference/, triage issues only

Also adds three drift-type-specific issue templates and removes the
old generic one.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant