Skip to content

[Docs] Clarify search pattern#3949

Open
heatherlarsen wants to merge 3 commits into
mainfrom
hl-documentation-search-only
Open

[Docs] Clarify search pattern#3949
heatherlarsen wants to merge 3 commits into
mainfrom
hl-documentation-search-only

Conversation

@heatherlarsen

@heatherlarsen heatherlarsen commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

📌 Summary

If merged, this PR updates the documentation about the differences between a standalone search input and search within filtering. I've updated the following pages to add clarity:

📸 Screenshots

Text Input Before:
Screenshot 2026-06-24 at 5 01 01 PM

Text Input After:
Screenshot 2026-06-24 at 5 04 59 PM

Filter Bar Before:
Screenshot 2026-06-24 at 5 00 38 PM

Screenshot 2026-06-24 at 5 00 46 PM

Filter Bar After:
Screenshot 2026-06-24 at 5 04 14 PM

Screenshot 2026-06-24 at 5 04 27 PM

🔗 External links

Jira ticket: HDS-6476
Context: Slack thread


💬 Please consider using conventional comments when reviewing this PR.

Add a Search subsection to the TextInput guidelines recommending a standalone search input for broad dataset queries (e.g., App Header) and advising embedding search into the Filter Bar or following Filter Patterns when searching within a filterable dataset. Includes links to the Filter Bar and Filter Patterns docs for further guidance.
Update filter bar guidelines to discourage using the Filter Bar for search-only features and recommend the Text Input instead. Rename and expand the Search section to "Integrating search", add Do/Don't callouts explaining that search should be used alongside filters (not by itself), and include an example image (filter-bar-search-no-filters.png) illustrating the incorrect search-only usage.
@heatherlarsen heatherlarsen requested review from a team as code owners June 25, 2026 00:03
@vercel

vercel Bot commented Jun 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hds-showcase Ready Ready Preview Jun 25, 2026 12:03am
hds-website Ready Ready Preview Jun 25, 2026 12:03am

Request Review

@hashibot-hds hashibot-hds added the docs-website Updates to the documentation website label Jun 25, 2026
@heatherlarsen heatherlarsen self-assigned this Jun 25, 2026
@heatherlarsen heatherlarsen changed the title Documentation: Clarify search pattern [Docs] Clarify search pattern Jun 25, 2026

@jorytindall jorytindall left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Non-blocking, but just a note about some of the prose, otherwise looks good!


### Search

Use a standalone search input when users are querying a broad dataset without immediate filtering needs, e.g., in the App Header.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's something that is throwing me off with this sentence; specifically around "immediate filtering needs" because I kind of view search in most capacities as a type of filter. Maybe something like:

Suggested change
Use a standalone search input when users are querying a broad dataset without immediate filtering needs, e.g., in the App Header.
Use a standalone search input when users are querying a broad dataset without fine-grained filtering needs, e.g., in the App Header.

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

Labels

docs-website Updates to the documentation website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants