Restructure the README: a short README, and a page in docs/ for each part
Merged
AL
5h ago+137+137+012345678901234567890123456789-95-95-01234567890123456789
Closes #24.
The README is now a short router, 55 lines where it was 116, and each part's detail is a page in docs/, as it was written, with the sentences that were out of date fixed.
What changes
README.mdsays what the site serves (a table of paths, with each one's source and page), how the three/h5p/pages divide the work between the chats that use them, how to run the site, how it is built and deployed, and what it pins and how a pin moves.docs/pdfjs-viewer.md,docs/h5p-build-page.md(with the type files, and the measurements under their own heading),docs/h5p-bundles.mdanddocs/h5p-skill.mdhold the old README's sections, moved with their text. Their links now resolve fromdocs/.- Fixed where the text was behind:
- embed-my.github.io's
/buildis a redirect that keeps the fragment, no longer "becomes". - The skill page also lists the build tool and every bundle, and
SKILL.mdsends a chat that has its text alone there first (0.9.1). - The type files are served twice, under
/h5p/build/types/and/h5p/skill/references/types/, from the same package. - The bundles' sizes: the largest is H5P.KewArCode's, 8.4 MB, and a container's (Branching Scenario's) 7.7 MB.
pnpm typecheckis listed, and what each pinned package moves.- Three sentences cubic found wrong, which came from the old README, are corrected: "Nothing leaves the browser" is now "The source is not uploaded" (the browser fetches the web addresses a source names), the Try button rewrites the first
https://missing-elements.github.ioof a snippet to the origin the docs run on (localUrl), and GitHub Pages cannot send a Content-Security-Policy header, where it was said to send no headers.
- embed-my.github.io's
- The build page's source editor (#27) is written up in
docs/h5p-build-page.md, as #27 makes it. Its two files are named there, not linked, so no link depends on the order the two merge in; the section is true once #27 is in.
Checked
Every claim that stayed was read against the source: the commands and ports, the workflows, the pins in package.json, .github/dependabot.yml, pnpm-workspace.yaml, the #source= fragment, the Try buttons, the player's h5p/ sub-scope, and the live site (the embed-my redirect and its /bundles/, the bundle sizes from index.json). Of the old README's 38 blocks, 17 are in the new files word for word and 21 are headings, links, tables or sentences edited as above. Every relative link and anchor in the new files resolves. No code changes.