Skip to content

chore(block-theme): add readme.md to the search overlay block#161

Open
laurelfulford wants to merge 1 commit into
mainfrom
docs/add-search-overlay-readme
Open

chore(block-theme): add readme.md to the search overlay block#161
laurelfulford wants to merge 1 commit into
mainfrom
docs/add-search-overlay-readme

Conversation

@laurelfulford
Copy link
Copy Markdown
Contributor

All Submissions:

Changes proposed in this Pull Request:

Matching what we've done for other block-theme related blocks so far, this PR adds a README.md for the Search Overlay block.

Closes NPPD-1539

How to test the changes in this Pull Request:

  1. Read through the README.md and make sure it makes sense. The main gotcha with this block is that Jetpack's Instant Search will "take over" for it if enabled.

Other information:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes, as applicable?
  • Have you successfully run tests with your changes locally?

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a README.md for the Overlay Search block, matching the documentation pattern used for other block-theme-only Newspack blocks.

Changes:

  • New README documents the block name, settings, styles, editor/front-end behavior, and Jetpack Instant Search handoff.
  • Notes block-theme-only availability and the panel relocation/scroll-lock/contrast runtime behavior.

@laurelfulford laurelfulford marked this pull request as ready for review May 29, 2026 18:46
@laurelfulford laurelfulford requested a review from a team as a code owner May 29, 2026 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants