Repository navigation
docs: README features first, Which setup in docs/setup.md, every claim checked - #189
Merged
Merged
Conversation
…m checked Features follow the header and the Quick start is shorter. The Which setup table moves whole to docs/setup.md, and the README keeps its answer in one line. Each claim was checked against its source: Rollup is no longer named (it emits no Service Worker, while Vite 8.3.8 and webpack 5.112.2 build and play the Quick start), the weekly line says what the jobs do, SCORM 2004 is named, jsDelivr is named for the pack, and the content-type and language counts, the browsers tested and the TypeScript declarations are added.
Contributor
There was a problem hiding this comment.
No issues found across 4 files
Tip: cubic could auto-approve low-risk PRs like this, if it thinks it's safe to merge. Learn more
View guided diff | Turn on auto-fix | Re-trigger cubic
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
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.
Docs only.
What changes
docs/setup.md, as its first section (#which-setup). The README keeps its answer in one line: packages you did not make, or a site with signed-in users, playuntrustedor embed the player from a domain of its own.docs/privacy.mdlinks there, anddesign/layout.mdsays so.docs/setup.md;docs/privacy.mdsays, and the privacy bullet names jsDelivr for the pack unless a copy is served;libraries="pack"is needed.Checked
xapilistener logginganswered. Rollup 4.68.2 with@rollup/plugin-node-resolveemitsmain.jsalone, so nothing plays. With@web/rollup-plugin-import-meta-assets3.0.1 the build stops on the element's defaultnew URL("frame-assets/", import.meta.url), a folder the package does not ship.docs/api.md, all there;untrustedagainstdocs/untrusted.mdandcontent-check.ts, a port ofH5PContentValidator;build-libraries.mjs, 53 types as of 2026-10-13;packages/runtime/l10n, 56 language files besideindex.json;docs/compatibility.md#browsers, the embed README's LMS table anddocs/privacy.md;NOTICE.md, zip.js in both Service Worker scripts;types, andnpx skills add --skillwith skills 1.8.1.Not changed
apps/demo/demo/setup.html,skills/h5p-player-setup/SKILL.md,design/build.md, and comments inpackages/player/src/h5p-offline-player.ts,packages/runtime/scripts/build.mjsandpackages/libraries/scripts/parts.mjs.prepackcopies it; h5p-author 0.9.4 does not carry it.Summary by cubic
Docs-only PR that reorganizes the README to lead with Features, shorten the Quick start, and move the Which setup table wholesale to
docs/setup.md. Every claim in the README was checked against its source, and several were corrected.docs/privacy.mdanddesign/layout.mdnow link to the moved Which setup section; all links and anchors were verified.Written for commit 35ad5e3. Summary will update on new commits.