Skip to content

DataViews: Clarify filtering behavior in DataViews configuration in README.md#70958

Merged
oandregal merged 1 commit intoWordPress:trunkfrom
chihsuan:update/dataviews-doc-filter-by
Jul 29, 2025
Merged

DataViews: Clarify filtering behavior in DataViews configuration in README.md#70958
oandregal merged 1 commit intoWordPress:trunkfrom
chihsuan:update/dataviews-doc-filter-by

Conversation

@chihsuan
Copy link
Copy Markdown
Member

What?

Updates the DataViews README documentation to clarify the filterBy configuration behavior and the relationship between elements and filtering.

Why?

The previous documentation was inaccurate and incomplete regarding how DataViews' fields currently handle filtering.

  • It didn't explain that filtering is enabled by default for all fields
  • It lacked documentation for the filterBy: false opt-out option

How?

Updated the README.md documentation

Testing Instructions

Review the updated documentation in packages/dataviews/README.md

@chihsuan chihsuan requested a review from oandregal as a code owner July 29, 2025 09:32
@github-actions
Copy link
Copy Markdown

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: chihsuan <chihsuan@git.wordpress.org>

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

@oandregal oandregal assigned oandregal and unassigned oandregal Jul 29, 2025
@oandregal oandregal added [Type] Developer Documentation Documentation for developers [Feature] DataViews Work surrounding upgrading and evolving views in the site editor and beyond labels Jul 29, 2025
@oandregal oandregal merged commit 428d27a into WordPress:trunk Jul 29, 2025
108 of 163 checks passed
@github-actions github-actions bot added this to the Gutenberg 21.4 milestone Jul 29, 2025
adamsilverstein pushed a commit to adamsilverstein/gutenberg that referenced this pull request Jul 31, 2025
….md (WordPress#70958)

Co-authored-by: chihsuan <chihsuan@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Feature] DataViews Work surrounding upgrading and evolving views in the site editor and beyond [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants