Skip to content

docs(blocks): document preview live embedding - #167

Merged
markdumay merged 12 commits into
mainfrom
release/docs-preview-live-embed
Oct 29, 2026
Merged

markdumay merged 12 commits into
mainfrom
release/docs-preview-live-embed

Conversation

@markdumay

Copy link
Copy Markdown
Contributor

Documents the preview extensions released in gethinode/mod-blocks v2.13.0. They cover device views and controls, click activation and posters, item tabs, the runtime fallback and open links, opt-in readiness (ready_message), parent-driven theme synchronization (theme_message), the window frame with visible activation, and narrow-screen static previews.

Changes

  • content/blocks/preview.md: the new arguments, defaults and behavior.
    • Corrects the stale sandbox list, the frame-ancestors note and the kebab-case Bookshop example.
    • Example links are pinned to the v2.13.0 tag.
    • The device-views live example uses a frame source that the docs CSP allows.
    • The build-time framing check is described as the code actually behaves: GET is retried only when HEAD returns an error, so a HEAD 404 is not retried. That gap is tracked in mod-blocks preview: a HEAD 404 skips the build-time framing check hinode#2287.
  • Two whitespace-only markdownlint fixes in the testimonial pages.

Validation

  • pnpm build and pnpm lint both pass.
  • Every argument name (snake and kebab), default, allowed value and numeric limit was checked against the v2.13.0 tag archive with a checker script. The reviewer's mutations of a default, a key spelling, an allowed value, the sandbox list and the timing limits were all caught.
  • Rendered in a scratch gethinode.com site with Hinode v3.46.1 and mod-blocks v2.13.0, under the production CSP:
    • All nine examples render.
    • The device-views example loads live at 1440px.
  • Independent blind review: the first round failed on one behavior finding and three claims. Those were repaired, re-reviewed, and corrected in a bounded wording round. The final verdict is PASS.

Refs gethinode/hinode#2268

🤖 Generated with Claude Code

markdumay and others added 12 commits October 26, 2026 06:11
Co-Authored-By: ChatGPT <noreply@openai.com>
Describe conditional framing checks and header request failures accurately.
Document legacy initial-frame timeout behavior and click readiness waits.

Co-Authored-By: ChatGPT <noreply@openai.com>
Document window framing, visible activation, and static narrow-screen behavior.
Clarify defaults, readiness timing, open-link priority, and producer examples.

Co-authored-by: Codex <noreply@openai.com>
Explain compact chrome, reduced margins, and the scroll fallback.
Keep the 24px target conditional on the geometry fitting available height.

Co-authored-by: Codex <noreply@openai.com>
Document opt-in theme coordination, state feedback, and frame styling.
Clarify guarded navigation and local examples for the preview block.

Co-authored-by: Codex <noreply@openai.com>
Document the applied-false signal on pagehide and new document startup.
Require fresh readiness and theme acknowledgement before revealing the frame.

Co-authored-by: Codex <noreply@openai.com>
Co-authored-by: Codex <codex@openai.com>
The preview page linked the producer example pages on main, which can
move after the release. Point them at the v2.13.0 tag.
Point the device-views example at the Wikipedia page that the module's
frame-src already covers, so a consuming docs site renders the live
iframe instead of the fallback alert.

Correct claims against mod-blocks v2.13.0 and Hinode v3.46.1: default
markup gains data attributes and a hidden unavailable block; a timed-out
frame is hidden and inert; Hinode ships only the before-change event,
so selector management is guidance for a cooperating child; HEAD falls
back to GET on any error; frame-ancestors overrides X-Frame-Options;
mobile_static falls back to image; the readiness example also sets
theme_message.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Correct claims against mod-blocks v2.13.0 and Hinode v3.46.1: GET is
retried only when HEAD returns an error, and a HEAD 404 leaves the
headers unchecked; a window alert has no link; mode posters need both
-light and -dark files; padding: 0 removes padding on both axes. Note
that the before-change event needs Hinode v3.45.0 or later, and point
the restated build-time check at Embedding restrictions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@markdumay
markdumay enabled auto-merge October 29, 2026 13:17
@markdumay
markdumay merged commit 22a9b00 into main Oct 29, 2026
8 checks passed
@markdumay

Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 1.16.5 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants