This repository was archived by the owner on Oct 21, 2026. It is now read-only.
Repository navigation
docs(core): replace contributor steps with getting started and AI quickstart - #3191
Merged
Merged
Conversation
…ckstart The core README shipped the i18n copy-editing procedure to npm. Move it into the i18n source README beside the locale steps, and point readers at the framework packages, adapters, and the CLI instead. Also fix the ./LICENSE links that 404 in nine package READMEs, a stray blank line in mux-data, and "Video.js v10" in package community blurbs. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for vjs-registry ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for vjs10-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@videojs/cdn
@videojs/cli
@videojs/core
@videojs/element
@videojs/html
@videojs/media
@videojs/react
@videojs/spf
@videojs/store
@videojs/utils
@videojs/cloudflare-video
@videojs/dash-video
@videojs/hlsjs-video
@videojs/mux-audio
@videojs/mux-video
@videojs/native-hls-video
@videojs/shaka-video
@videojs/spotify-audio
@videojs/tiktok-video
@videojs/twitch-video
@videojs/vimeo-video
@videojs/wistia-video
@videojs/youtube-video
@videojs/google-cast
@videojs/mux-data
commit: |
Contributor
📦 Bundle Size Report🎨 @videojs/html — no changesPresets (7)
Media (18)
Players (5)
Skins (41)
UI Components (62)
⚛️ @videojs/react — no changesPresets (7)
Media (22)
Extensions (2)
Players (5)
Skins (26)
UI Components (39)
🧩 @videojs/core — no changesEntries (76)
🏷️ @videojs/element — no changesEntries (2)
📦 @videojs/store — no changesEntries (3)
🔧 @videojs/utils — no changesEntries (13)
📦 @videojs/cdn — no changes📦 @videojs/cloudflare-video — no changes📦 @videojs/dash-video — no changes📦 @videojs/google-cast — no changes📦 @videojs/hlsjs-video — no changes📦 @videojs/media — no changesEntries (3)
📦 @videojs/mux — no changes📦 @videojs/mux-audio — no changesEntries (2)
📦 @videojs/mux-data — no changes📦 @videojs/mux-video — no changesEntries (2)
📦 @videojs/native-hls-video — no changes📦 @videojs/shaka-video — no changes📦 @videojs/spf — no changesEntries (7)
📦 @videojs/spotify-audio — no changes📦 @videojs/tiktok-video — no changes📦 @videojs/twitch-video — no changes📦 @videojs/other — no changesEntries (3)
📦 @videojs/vimeo-video — no changes📦 @videojs/wistia-video — no changesEntries (2)
📦 @videojs/youtube-video — no changesℹ️ How to interpretEach entry is independently bundled, minified, and brotli-compressed. Initial size includes its static import graph; lazy dynamic chunks are reported separately. Entries are not additive because their dependency graphs overlap. Preset rows represent realistic combined bundles. Changes of 300 B or less across initial, lazy, and total size are collapsed, not discarded. Run |
sampotts
approved these changes
Oct 6, 2026
Core is never installed directly, but its README now routes readers to the framework packages that the installation instructions cover. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
@videojs/coreREADME published a contributor procedure ("Update i18n copy") to npm and had no getting-started guidance. This replaces it with reader-facing content and cleans up a few other README oddities.@videojs/html,@videojs/react, and@videojs/cdnplus adapter and extension packages, an AI Quickstart (agents skills, thenagents init --framework html|react), and docs links. Drops the "React Native" mention; there is no such package.packages/core/src/core/i18n/README.mdbeside the existing "Adding a built-in locale" steps../LICENSE, which does not exist in any package directory. They now link../../LICENSE, as the adapter andvideo.jsREADMEs already do.workspace-contract.test.ts(from feat(installation): add versioned agent instructions #2948) only allowed an AI Quickstart in packages thatagents initinstalls. It now also allows@videojs/core, whose quickstart routes readers to@videojs/htmland@videojs/react.mux-data.Follows the same pattern as the
video.jspackage guide in #3128.Not changed
@videojs/native-hls-video,@videojs/shaka-video, and@videojs/wistia-videostill have no AI Quickstart section, unlike the other adapters.icons,skins) keep their contributor-oriented READMEs, since they are not published.Test plan
pnpm check:workspacepnpm -F @videojs/installation test src/tests/workspace-contract.test.ts🤖 Generated with Claude Code
Note
Low Risk
Documentation and a test allowlist tweak only; no runtime or API behavior changes.
Overview
Reframes
@videojs/core’s published README for consumers: it now explains what core is, how to pick@videojs/html/@videojs/react/@videojs/cdn(and optional adapters/extensions), links to framework docs, and adds an AI Quickstart (agents skills, thenagents init --framework html|react). The old “Update i18n copy” contributor workflow is moved intopackages/core/src/core/i18n/README.mdunder “Changing player copy,” not removed.Fixes broken license links in nine package READMEs (
./LICENSE→../../LICENSE) and standardizes community copy (“Video.js v10” → “Video.js 10”). Root README AI text now says “your installed version” instead of “this package version.”Updates the installation workspace contract test so
@videojs/coremay include an AI Quickstart even though it isn’t installed directly—its README points readers at the framework packages.Reviewed by Cursor Bugbot for commit f01b8d6. Bugbot is set up for automated code reviews on this repo. Configure here.