Skip to content

docs(global-search): document re-architecture improvements#977

Merged
romanbracinik merged 4 commits into
mainfrom
romanbracinik-dmd-1641-global-search-update-helpkeboolacom
Jun 23, 2026
Merged

docs(global-search): document re-architecture improvements#977
romanbracinik merged 4 commits into
mainfrom
romanbracinik-dmd-1641-global-search-update-helpkeboolacom

Conversation

@romanbracinik

Copy link
Copy Markdown
Contributor

Linear issue: DMD-1641 (Global Search re-architecture milestone)

Updates the Global Search page to reflect the user-facing improvements from the Global Search re-architecture.

Changes:

  • Confidentiality framing now states search runs over entity names and, for tables, their column names — never the data inside (DMD-1601).
  • Table entity type noted as findable by its column names, not just the table name.
  • "Using Global Search" documents the Matched column hint shown when a table matches via a column, with a screenshot (DMD-1648).
  • New Matching section: relevance-based name matching (column matches rank below name matches), exact ID matching for renamed entities (DMD-1643), and opt-in Regex mode via the search-bar toggle, with a screenshot (DMD-1600).
  • BETA notice kept.

Screenshots captured against a local keboola/ui build with global-search-backend enabled. Verified with npm run build (clean) and node scripts/audit-phase2.mjs (MISSING IMAGES: 0).


Draft — opened for review. Proofreading: create a PROOF issue if needed.

@linear

linear Bot commented Jun 21, 2026

Copy link
Copy Markdown

DMD-1641

@vercel

vercel Bot commented Jun 21, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
connection-docs Ready Ready Preview, Comment Jun 23, 2026 7:28am

Request Review

Update the Global Search page for the re-architecture work:
- search/confidentiality framing now covers table column names (DMD-1601)
- Table entity type is findable by its column names
- "Matched column" hint in results, with screenshot (DMD-1648)
- new "Matching" section: name matching, exact ID (DMD-1643),
  opt-in regex mode via the search-bar toggle (DMD-1600), with screenshot

DMD-1641
@romanbracinik romanbracinik force-pushed the romanbracinik-dmd-1641-global-search-update-helpkeboolacom branch from 4439834 to 9b2c79a Compare June 21, 2026 10:00
@romanbracinik romanbracinik marked this pull request as ready for review June 22, 2026 05:55

@keboola-pr-reviewer-bot keboola-pr-reviewer-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Verdict: needs_human (risk 2/5) · profile docs

Placeholder alt text on both new images triggers a flag: from the asset-hygiene skill, which the policy says drops any verdict to needs_human.

Concerns:

  • src/content/docs/management/global-search/index.md: Alt text 'Screenshot - Matched column' uses placeholder word 'Screenshot'; describe what the UI shows instead.
  • src/content/docs/management/global-search/index.md: Alt text 'Screenshot - Regex mode' uses placeholder word 'Screenshot'; use a descriptive caption.
  • src/content/docs/management/global-search/index.md: New product-behaviour claims (column indexing, exact-ID lookup, Regex mode) cannot be verified from the diff alone.

Suggested reviewers: keboola/docs

Address pr-reviewer-bot: replace placeholder 'Screenshot - ...' alt text
on the matched-column and regex images with descriptive captions.

DMD-1641
@romanbracinik

Copy link
Copy Markdown
Contributor Author

Addressed the pr-reviewer-bot feedback:

  • Replaced the placeholder Screenshot - ... alt text on both new images with descriptive captions (commit 951d778).
  • On the "claims can't be verified from the diff alone" point: the three behaviours documented here were verified live against a local keboola/ui build with the global-search-backend feature enabled — column-name matching with the Matched column hint (DMD-1648 / DMD-1601), exact-ID lookup (DMD-1643), and the opt-in Regex toggle (DMD-1600). The screenshots in this PR are from that session.

@keboola-pr-reviewer-bot keboola-pr-reviewer-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Verdict: needs_human (risk 2/5) · profile docs

This PR introduces multiple substantive product-behaviour claims that cannot be verified from the diff alone.

Concerns:

  • src/content/docs/management/global-search/index.md: New Matching section asserts column-vs-name relevance ranking — unverifiable product-behaviour claim.
  • src/content/docs/management/global-search/index.md: Exact ID matching and Regex mode behaviour are new product-behaviour claims needing author/product confirmation.
  • public/management/global-search/global-search-matched-column.png: Screenshots from local dev build — human should confirm they reflect current production UI state.

Suggested reviewers: keboola/docs

@romanbracinik romanbracinik requested a review from a team June 22, 2026 06:07
Comment thread src/content/docs/management/global-search/index.md Outdated
Use monthlyReport instead of monthly_report in the regex whole-name
example to avoid implying the underscore is a word separator.

DMD-1641
@romanbracinik romanbracinik merged commit 3970894 into main Jun 23, 2026
3 checks passed
@romanbracinik romanbracinik deleted the romanbracinik-dmd-1641-global-search-update-helpkeboolacom branch June 23, 2026 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants