Skip to content

docs(create-block-interactive-template): document available variants in README#76831

Merged
juanmaguitar merged 1 commit intotrunkfrom
worktree-add+interactive-client-side-navigation-variant
Mar 27, 2026
Merged

docs(create-block-interactive-template): document available variants in README#76831
juanmaguitar merged 1 commit intotrunkfrom
worktree-add+interactive-client-side-navigation-variant

Conversation

@juanmaguitar
Copy link
Copy Markdown
Contributor

@juanmaguitar juanmaguitar commented Mar 26, 2026

Closes #76827

Documents the three variants exposed by @wordpress/create-block-interactive-template in its README.

Why?

The package has supported default, typescript, and client-side-navigation variants for some time, but the README only showed the base usage command with no mention
of the --variant flag. Users had no way to discover TypeScript support or the client-side navigation demo without reading the package source.

How?

Adds a ## Variants section to the README with a subsection for each variant covering:

  • what it demonstrates
  • the exact npx @wordpress/create-block command to use it
  • any notable extra dependencies (e.g. @wordpress/interactivity-router for client-side-navigation)

No code changes — documentation only.

Testing Instructions

  1. Open packages/create-block-interactive-template/README.md.
  2. Verify a Variants section is present with subsections for default, typescript, and client-side-navigation.
  3. Optionally, run each documented command and confirm the scaffolded block matches the description.

Testing Instructions for Keyboard

N/A — documentation-only change, no UI affected.

Use of AI Tools

This PR was drafted with the assistance of Claude Code (Anthropic). The content was reviewed and approved by the author.

@juanmaguitar @claude
docs(create-block-interactive-template): document available variants …
caf4443 
…in README

Adds a Variants section listing all three variants (default, typescript,
client-side-navigation) with their purpose and exact invocation commands.
Fixes #76827.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@juanmaguitar juanmaguitar added [Type] Developer Documentation Documentation for developers [Package] Interactivity Router /packages/interactivity-router labels Mar 26, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 26, 2026

Flaky tests detected in caf4443.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/23593344021
📝 Reported issues:

luisherranz
luisherranz approved these changes Mar 27, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@luisherranz luisherranz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🎉

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 27, 2026

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: juanmaguitar <juanmaguitar@git.wordpress.org>
Co-authored-by: luisherranz <luisherranz@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@juanmaguitar juanmaguitar merged commit 41fc7ec into trunk Mar 27, 2026
47 of 51 checks passed
@juanmaguitar juanmaguitar deleted the worktree-add+interactive-client-side-navigation-variant branch March 27, 2026 07:11
@github-actions github-actions bot added this to the Gutenberg 22.9 milestone Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@luisherranz luisherranz luisherranz approved these changes

@DAreRodz DAreRodz Awaiting requested review from DAreRodz

Assignees

No one assigned

Labels

[Package] Interactivity Router /packages/interactivity-router [Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 22.9

Development

Successfully merging this pull request may close these issues.

create-block-interactive-template: README does not document available variants

2 participants

@juanmaguitar @luisherranz