Repository navigation
README: the whole toolkit at the root, and the player's own README for npm - #235
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 3 files
Reply with feedback, questions, or to request a fix.
View guided diff | Turn on auto-fix | Re-trigger cubic
Contributor
There was a problem hiding this comment.
All reported issues were addressed across 6 files (changes from recent commits).
Reply with feedback, questions, or to request a fix.
View guided diff | Turn on auto-fix | Re-trigger cubic
…RM come from their packages; the quick start names libraries="pack" (#234)
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.
Closes #234.
The repository is now
h5p-toolkit, but its README still put the player at the centre. This PR makes the root README the toolkit's front page. The player gets a README of its own, which is what npm shows.What changes
packages/player/README.md, now tracked, is the player's page as npm showed it, titled@missing-elements/h5p-offline-player.prepackcopies only LICENSE now, so this PR's earlier title swap goes..gitignorestops ignoring the player's README.h5p-cmi5andh5p-embed.libraries="pack".Tested
node packages/player/scripts/prepack.mjscopies LICENSE and leaves the tracked README alone.npm pack --dry-runlists the player's own README.md and LICENSE.pnpm typecheckpasses.github.com/missing-elements/h5p-toolkit/blob|tree/main/…link in both READMEs points at a file or folder that exists.npx skills add … --skill;npx @missing-elements/h5p-verify@latestand Node 22 or later (the packages'engines);package.json);Not verified
Summary by cubic
The root README now presents the whole toolkit, and
@missing-elements/h5p-offline-playerkeeps its own README for npm instead of a copied root one with a replaced title.packages/player/README.mdis the player's page on npm, titled with the package's name and holding the player-focused content the root README used to carry.README.mdis rewritten as the toolkit's front page, covering the player, AI authoring, verification, and the surrounding packages.prepack.mjsnow copies only the LICENSE;design/build.mdanddesign/licensing.mddescribe the new setup.docs/compatibility.mdstates the browser suite runs in Chromium on every change and in Firefox and WebKit weekly and before each player release.Written for commit 600fed7. Summary will update on new commits.