Skip to content

docs: say what the player does, and a guide for packages you did not make - #27

Merged
alekswebnet merged 2 commits into
mainfrom
docs/what-it-does
Oct 14, 2026
Merged

alekswebnet merged 2 commits into
mainfrom
docs/what-it-does

Conversation

@alekswebnet

Copy link
Copy Markdown
Contributor

Closes #26.

README

A What it does section now sits between the intro and Which setup. It has one line per capability, each linking to its guide:

  • plays the packages people have: streaming, hosts without Range, the library pack, old content upgraded;
  • validates what it plays: untrusted, the content check, and the entry-name and library checks every package gets;
  • gives results you can audit: revision, finished, cmi5, resume;
  • works offline, in the learner's language;
  • comes with tools for pipelines: verify, normalize, embed, skills;
  • is tested where it runs: three engines, and every content type in the pack.

The new guide is first in Guides, and the untrusted paragraph under Which setup links to it.

docs/untrusted.md, "Packages you did not make"

  • What's withheld: the package's library folders, non-content file types, sniffing, and 'self' in the script policy.
  • The content check: what it does to each kind of field, and why it's needed even with the code withheld. It also records how the port was compared with the PHP original (98 cases, 96 identical) and that it fails closed on runtimes older than 0.2.
  • When a package is refused: with an example that asks the visitor before playing it trusted when missingLibraries.carried is set.
  • Checks every package gets, untrusted or not: entry names, and the library tree.
  • What it doesn't cover: your libraries are your code; the Firefox difference; Embed for sites with signed-in users; correctness is h5p-verify's job.

Other docs

  • docs/frame-csp.md and docs/libraries.md point to the new guide. The CSP guide no longer describes the check itself.
  • AGENTS.md lists the new guide.

Release

None now. The README reaches npm with the next player release.

Not changed

The demo site's own pages, setup.html and compare.html, still describe untrusted as they did. Updating them is a separate change.

🤖 Generated with Claude Code

alekswebnet and others added 2 commits October 14, 2026 09:39
…make

The README now opens with what the player does beyond playing a package:
streaming, validation, results for audits, offline and languages, the tools,
and the testing, each linking to its guide. docs/untrusted.md gathers what
`untrusted` withholds, the content check and how it was compared with
H5P's PHP validator, handling a refusal with `carried`, and the checks every
package gets; the CSP and libraries guides point to it.

Closes #26.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@alekswebnet alekswebnet self-assigned this Oct 14, 2026
@alekswebnet
alekswebnet merged commit de720a6 into main Oct 14, 2026
7 checks passed
@alekswebnet
alekswebnet deleted the docs/what-it-does branch October 15, 2026 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README: say what the player does, and give validation a guide of its own

1 participant