docs(site): label beta API references - #2513
Merged
Merged
Conversation
✅ 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/core
@videojs/element
@videojs/html
@videojs/media
@videojs/react
@videojs/spf
@videojs/store
@videojs/utils
commit: |
Contributor
📦 Bundle Size Report🎨 @videojs/html — 75 small size changes
Presets (7)
Media (20)
Players (5)
Skins (29)
UI Components (50)
⚛️ @videojs/react — 70 small size changes
Presets (7)
Media (24)
Players (5)
Skins (26)
UI Components (39)
🧩 @videojs/core — 2 small size changes
Entries (76)
🏷️ @videojs/element — no changesEntries (2)
📦 @videojs/store — no changesEntries (3)
🔧 @videojs/utils — no changesEntries (13)
📦 @videojs/media
Entries (23)
📦 @videojs/spf — no changesEntries (10)
ℹ️ 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 |
decepulis
marked this pull request as ready for review
August 27, 2026 23:13
mihar-22
approved these changes
Aug 28, 2026
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Add page-owned API stability metadata so individual references can communicate maturity consistently. Mark the Dash and Shaka media APIs as Beta in both the page header and docs sidebar.
Changes
stability: betafield to docs frontmatterTesting
pnpm -F site api-docspnpm -F site astro checkenv CI=true pnpm -F site testpnpm check:workspaceenv -u SENTRY_AUTH_TOKEN CI=true pnpm build:siteNote
Low Risk
Documentation-site presentation and content schema only; no player runtime or security-sensitive behavior changes.
Overview
Adds optional
stability: betaon docs reference frontmatter (validated viaDOC_STABILITIES) so individual APIs can declare maturity on the page.When set,
ApiStabilityBadge(built on a new sharedPillcomponent;BetaPillnow composesPill) appears next to the title in the reference header and on matching sidebar links. The docs layout builds adocStabilitiesmap from all docs and threads it throughDocsSidebar/SidebarItem.DashVideo and ShakaVideo are marked beta, and author guides (
mdx-structure.md,write-references.mdx) document the field.Reviewed by Cursor Bugbot for commit 60ad21e. Bugbot is set up for automated code reviews on this repo. Configure here.