Repository navigation
docs(webapi): document alpha and validate docs distribution [Codex] - #398
jderochervlk wants to merge 20 commits into
Conversation
Independent review —
|
…nto agent/alpha-docs-distribution
Independent re-review —
|
Independent final review —
|
Independent follow-up review —
|
This stacks the documentation/distribution work on binding-contract PR #399, which is itself stacked on tooling/release PR #397. It does not publish packages, create tags, close historical backlog issues, or change GitHub/npm settings.
For #393, the README and documentation landing pages distinguish the ReScript 13.0.0-alpha.5 tested baseline from the wider prerelease peer range, document the alpha breaking-change contract, provide a normal install/config/example, and state that the registry
alphatag still points to the older 0.1.0-alpha-b1d58f9 until an authorized alpha.1 publication. The candidate consumer is verified from its packed tarball. Contributor setup uses a fast-forward-only update workflow without destructive cleanup. Architecture, modelling, generation, documentation, and testing guides now describe the flat public API and current fixture/compiler/browser workflow. Project status reconciles #236, #237 and its now-closed slices #240-243, #27, #23, #4, and #5 without closing them or making them alpha gates.CHANGELOG.mdrecords the binding migration contracts from the stacked branch, including typed bytes/audio buffers, WebCrypto helpers, empty and nullable results, operation-specific IndexedDB deletion, and DOM/SVG changes.For #394, generated signature links resolve through the public API manifest and a unique public type alias owner; ambiguous/internal references remain unlinked. The examples link respects Astro's configured base path.
npm run check:docs-linksvalidates required docs routes, local HTML and SVG fragments, page/asset links (including CSSurl()/imports and inline styles), and same-site absolute routes; fixtures cover base traversal, duplicate prefixes, comments/strings, escaped CSS identifiers, entity/percent fragments, and empty/incomplete artifacts. CI and the unprivileged release validation job run this checker immediately after the docs build. External URLs and canonical metadata are intentionally not verified by the local route checker.For #395, repository history and actual WOFF2 metadata did not establish source release/version provenance or applicable licenses for the bundled Inter/Roboto Mono files. The binaries and their dead CSS/layout references are removed rather than assigning an unverified license. The site uses documented system sans-serif/monospace stacks; visual metrics can vary with the reader's installed fonts. The attribution page is emitted in the built docs, and the source-only npm package still excludes documentation assets.
The release guide covers the initial
1.0.0-alpha.1version/tag, later synchronized package/lock bumps, release notes, the tested check sequence, exact-artifact validation and dry-run, main/manual publication guard, and post-publish dist-tag check. The npm trusted-publisher tuple is recorded, but npm account configuration/provenance setup remains an explicit maintainer-only check; #385 is not claimed fully complete by this documentation change. The local registryalphatag is still on the prior prerelease, and no publication was performed.Closes #393
Closes #394
Closes #395