docs(root): fix stale references and document sandbox workflow#1464
Merged
docs(root): fix stale references and document sandbox workflow#1464
Conversation
Update contributor-facing docs to match the current workspace and help newcomers discover how to manually test player changes. - Fix broken `cd vjs-10` step in the clone instructions. - Fix stale `vjs-10-monorepo.git` URL in the root package.json. - Document typecheck, check:workspace, and single-file lint commands. - Add "Manual Testing with the Sandbox" section covering the templates/src split and the gitignore trap. - Expand slash-command and skills tables; point to the skills README as the canonical index. - Add packages/cli and apps/e2e to the CLAUDE.md package layout; include icons/skins in the runtime dependency summary. - Fix sandbox README filter shortcuts (prefer dev:sandbox and the full @videojs/sandbox scope). - Standardize the Beta tagline in the spf README.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Deploy Preview for vjs10-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📦 Bundle Size Report🎨 @videojs/html — no changesPresets (7)
Media (8)
Players (3)
Skins (29)
UI Components (25)
Sizes are marginal over the root entry point. ⚛️ @videojs/react — no changesPresets (7)
Media (7)
Skins (26)
UI Components (20)
Sizes are marginal over the root entry point. 🧩 @videojs/core — no changesEntries (9)
🏷️ @videojs/element — no changesEntries (2)
📦 @videojs/store — no changesEntries (3)
🔧 @videojs/utils — no changesEntries (10)
📦 @videojs/spf — no changesEntries (3)
ℹ️ How to interpretAll sizes are standalone totals (minified + brotli).
Run |
Repo is past both milestones and heads-down on GA.
The package is published to npm but had no README, leaving a blank landing page. Adds command reference, install flags, and config keys.
Removes duplicated flag/option tables that restate what 'videojs --help', 'videojs docs --help', and 'videojs config --help' already print. Keeps one example per command and the installation snippet demo.
Signals that @videojs/skins is not meant to be installed directly and points contributors to the html/react packages that re-export skins.
Adds internal/decisions/ to CLAUDE.md's Design Documents table with a short distinction from internal/design/ (ADR-style single-decision records vs architecture/feature specs), a README explaining the format and naming convention, and a cross-link from internal/design/README.md.
Per-command subheadings and docs --list example removed — --help is the source of truth for flag reference. Keeps one doc-reader example and the interactive installation snippet since that's the distinctive feature. Also drops 'Close to stable' from the Beta banner and rewords the cli description in CLAUDE.md's Package Layout to acknowledge future scope beyond docs.
Reverts the earlier standardization — SPF isn't close to stable yet, so the banner shouldn't imply it is.
…e claims - Sandboxes table listed entry names that don't exist (core, html, html-tailwind, react, etc.) — replaced with pointer to the dynamic root index and templates/ directory. - How it works now describes all three participating directories (app/ shell + shared, templates/, src/) instead of two, and explains the @app/* alias that templates use to import shared helpers. - Add a Resetting section for 'pnpm -F @videojs/sandbox reset' — the destructive counterpart to sync. - Correct 'gitignored (except index.html)' — .gitignore is src/* with no exception; src/index.html is generated by the serve-app-shell Vite plugin on every dev/build. - Adding a new sandbox: drop the stale steps about editing templates/index.html (doesn't exist) and registering entries in vite.config.ts (auto-discovered via getSandboxEntries). CONTRIBUTING.md carried the same stale entry list and gitignore-trap wording from the old sandbox README — fixed to match reality. Also fixes an inconsistent plans link in internal/decisions/README.md.
…tations The root route isn't a directory listing — it's an interactive shell (app/shell/app.tsx) with dropdowns for platform/preset/skin/styling/source driving an iframe preview of the selected combination. One-off templates outside that matrix (firefox-mse-repro, spf-segment-loading, etc.) are reachable only by direct URL. Also correct the dev command commentary: 'pnpm dev:sandbox' already runs all workspace package deps in watch mode (turbo filter '...' includes deps, every package has a 'dev' → build:watch script). The difference from 'pnpm dev' is whether the docs site also runs, not whether packages watch.
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
Review pass over
README.md,CONTRIBUTING.md,CLAUDE.md, and the package READMEs. This first commit covers the unambiguous fixes; a few decisions are still open (see below).Fixed
cd vjs-10step in the clone instructions (CONTRIBUTING.md).vjs-10-monorepo.gitURL in the rootpackage.json.apps/sandbox/README.mdfilter shortcuts (preferpnpm dev:sandboxand the full@videojs/sandboxscope).packages/spf/README.md.Added / expanded
templates/vssrc/and warning about the gitignore trap.pnpm typecheck, with the "build types first" tip).pnpm check:workspace).dev:packages/dev:sandboxto the Build & Development commands.lint:fix:fileto the lint commands..claude/skills/README.md.packages/cliandapps/e2eto the Package Layout table.icons, skins → html / reactto the runtime dependency summary.Still open (not in this PR)
packages/cli/README.mdis missing (package is publicly published).packages/skins/README.md— stub or skip?packages/react-native/empty directory — keep or remove?internal/decisions/is undocumented in the Design Docs section ofCLAUDE.md.Test plan
pnpm typecheckpnpm check:workspacehttps://claude.ai/code/session_01X2pMP6QdefgPf1VSjQ4B4b
Generated by Claude Code
Note
Low Risk
Low risk: changes are documentation/metadata only and do not affect runtime behavior; main risk is minor confusion if instructions/links are incorrect.
Overview
Refreshes root docs (
README.md,CONTRIBUTING.md,CLAUDE.md) to fix stale repo references/commands, expand contributor workflow guidance (typechecking, workspace checks, linting), and document how to manually test changes via the sandbox.Introduces a clearer design documentation taxonomy by adding
internal/decisions/README.mdand updatingCLAUDE.md/internal/design/README.mdto distinguish design docs vs ADR-style decisions.Adds missing package READMEs for
@videojs/cliand internal@videojs/skins, and updates rootpackage.jsonrepository URL.Reviewed by Cursor Bugbot for commit 1c9a243. Bugbot is set up for automated code reviews on this repo. Configure here.