Skip to content

The documentation site: front page, guides, schema reference, conformance, proposals, versions (DR-185) - #37

Merged
datajace merged 4 commits into
mainfrom
docs/site
Oct 6, 2026
Merged

datajace merged 4 commits into
mainfrom
docs/site

Conversation

@datajace

@datajace datajace commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

A documentation site on the existing GitHub Pages deployment, generated on every deploy from the files npm test checks. The schema bytes at every $id and under each /<version>/ are laid out by the workflow exactly as before and never touched by the generator.

What. Four signed commits, one per spec task:

  • 88cb03a: tooling/build-site.mjs and tooling/site.css; marked 18.1.0 pinned exactly as a devDependency (zero transitive dependencies, not in the tarball); the front page, the SPEC, README, GOVERNANCE, CONTRIBUTING, SECURITY and CHANGELOG as pages, the guides, the conformance and proposals indexes, the versions page and the frozen-copy index pages, a 404 page. GitHub's heading-slug algorithm; relative links rewritten to site paths with an unknown path aborting the build. One docs fix the build found: an unescaped pipe inside a table code span in docs/upgrading-1.0-to-1.2.md.
  • 7eac75c: tooling/site-reference.mjs, the schema reference: one page per schema walked from the schema files with every property's path, type, required (including conditional), description, constraints and stability; $ref rows link to definitions; the three inlined copies walked in place and labelled.
  • aba2d21: conformance/site-check.mjs in npm test: links and anchors, every schema and docs file paged, the 1.x/ bytes compared to schemas/, no script or external resource, two builds compared; NOT CHECKED from the installed package, which has no tooling/.
  • fb7445c: pages.yml builds the pages after its unchanged schema layout; README "The site"; CHANGELOG.

Checks. npm test: Site: 32 pages, 591 links, 0 failure(s)., Conformant.; the workflow's build step simulated locally with 1.x/ and the six frozen directories (38 pages); the installed-package run prints Site: NOT CHECKED and Conformant.; three mutation proofs (an unknown link, a planted script tag, one changed schema byte) each failed npm test naming the page and reason. The tarball gains one file, conformance/site-check.mjs, because run.mjs imports it.

No page carries a script or reaches another host. No schema, fixture, lock, guard or SPEC text changes; no release needed. Governed as harness spec build-documentation-site-governance-contract (DR-185); Linear COGDEV-278.

🤖 Generated with Claude Code

datajace and others added 4 commits October 6, 2026 19:33
… task 1.1)

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: Jason Cruz Falzon <jason@cognitivedelivery.co.uk>
…selves (DR-185, task 1.2)

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: Jason Cruz Falzon <jason@cognitivedelivery.co.uk>
…sm (DR-185, task 2.1)

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: Jason Cruz Falzon <jason@cognitivedelivery.co.uk>
…ion; CHANGELOG (DR-185, task 2.2)

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: Jason Cruz Falzon <jason@cognitivedelivery.co.uk>
@datajace
datajace merged commit bab3ae3 into main Oct 6, 2026
10 checks passed
@datajace
datajace deleted the docs/site branch October 6, 2026 19:02
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.

1 participant