Skip to content

docs(v0.44): synchronize public API, authoring model and release truth (#1218) - #1261

Merged
SisyphusZheng merged 1 commit into
devfrom
v044/a10.10-docs-truth
Sep 2, 2026
Merged

docs(v0.44): synchronize public API, authoring model and release truth (#1218)#1261
SisyphusZheng merged 1 commit into
devfrom
v044/a10.10-docs-truth

Conversation

@SisyphusZheng

Copy link
Copy Markdown
Member

Problem

Issue #1218 (umbrella #1155, Alpha.10, H5 class). Public-facing truth drifted from source: package READMEs taught removed APIs (defineElement/VNode/object-descriptor definePage), SECURITY.md claimed unwired tools, README.zh described an alpha-lag policy impossible under ADR-0151, www guides used removed authoring vocabulary, HYDRATION_CONTRACT referenced marker-activation/For-era semantics.

Evidence-first approach

Extended tools/check-docs-truth.ts with a mechanical removed-vocabulary gate (test-first, 3 unit tests). At baseline it found 54 drift findings across 16 files — every one fixed to source truth; gate now green and prevents regression.

Evidence

  • RED: current gate failed with 54 findings on the real tree; GREEN after fixes.
  • Gates: tools/ suite 451 passed; docs:truth (all sub-gates) exit 0; fmt/lint/package-surface/interface:snapshot exit 0; www content data generation exit 0. Full deno task test not run — docs-only + checker change; no package/e2e test references the edited documents (grep-verified); stated per packet rule.
  • Fresh kimi-code/k3-256k HIGH implementer session; orchestrator re-ran the checker tests.

Scope / non-goals

No docs framework; no historical-record rewrites (docs/audit, ADR bodies, migration guide's historical sections allow-listed); no www visual redesign. Out-of-scope drift filed as #1260 (www/app apilist/page-home + desktop-reader comments).

Risk

Docs-only + one checker extension. Rollback: revert.

#1218)

Alpha.10 truth closure (H5 class). A new mechanical removed-vocabulary
gate in check-docs-truth found 54 drift findings across 16 files at
baseline; all fixed to the BASE_SHA source truth:

- package READMEs rewritten to the current compiled authoring model
  (@element/@Property intrinsics, class-first definePage); create README
  dist-tag claim corrected to the 0.43 line
- SECURITY.md overclaim removed (only dependency-review + CodeQL are
  wired; Gitleaks/actionlint/zizmor/Scorecard marked planned via #1156)
- README.zh alpha-lag claim removed (alphas are internal under ADR-0151)
- www guide/architecture content re-authored (canonical imports,
  projector pattern, compiled claim vocabulary); HYDRATION_CONTRACT and
  PACKAGE_SURFACE updated; integrations docs fixed
- check-docs-truth current gate now mechanically rejects removed
  authoring vocabulary (defineElement, useLoaderData, useActionData,
  bindSsrProps, registerSignal, <For>, VNode-as-current) on current
  surfaces; historical records allow-listed

Follow-up filed for out-of-scope www/app surfaces: #1260.
Implemented by fresh kimi-code/k3-256k HIGH session
(.agents/v044-kimi-implementer.md), packet A10.10. No publish, no tag.
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

APIError: Insufficient Balance

opencode session  |  github run

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying openelement with  Cloudflare Pages  Cloudflare Pages

Latest commit: d298f9f
Status: ✅  Deploy successful!
Preview URL: https://00d8965e.lessjs.pages.dev
Branch Preview URL: https://v044-a10-10-docs-truth.lessjs.pages.dev

View logs

@SisyphusZheng
SisyphusZheng merged commit e3f8fcb into dev Sep 2, 2026
9 checks passed
@SisyphusZheng
SisyphusZheng deleted the v044/a10.10-docs-truth branch September 3, 2026 09:49
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