Skip to content

DOCS-1827 - Consolidate Query Assist into Search Autocomplete - #7061

Merged
kimsauce merged 4 commits into
mainfrom
DOCS-1827
Sep 2, 2026
Merged

DOCS-1827 - Consolidate Query Assist into Search Autocomplete#7061
kimsauce merged 4 commits into
mainfrom
DOCS-1827

Conversation

@kimsauce

Copy link
Copy Markdown
Collaborator

Purpose of this pull request

Retires the standalone Query Assist doc, which was never a UI-labeled feature, and merges its content into the existing Search Autocomplete page. Adds cross-link notes so Search Autocomplete, AI Parse Assist, and Mobot's Log Analysis Agent (three easily-confused AI-assisted search capabilities) are clearly distinguished from one another. Fixes two dead release-note links that pointed at the retired page, adds a redirect for the old URL, and removes orphaned/stale screenshots. Also includes an unrelated small fix: shrinks the account-preferences icon and moves it inline with its instruction text in two other docs.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-1827

kimsauce and others added 2 commits August 25, 2026 16:17
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…on text

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@kimsauce kimsauce self-assigned this Aug 25, 2026
@cla-bot cla-bot Bot added the cla-signed Contributor approved, listed in .clabot file label Aug 25, 2026
@kimsauce
kimsauce marked this pull request as draft August 26, 2026 10:16
@JV0812

JV0812 commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator

Heads-up: cross-PR conflict with #7058

While reviewing #7058 ("DOCS-1798 - Cross-link Mobot on high-traffic search docs"), I noticed it modifies docs/search/query-assist.md (uncommenting a Mobot callout there), while this PR deletes that same file entirely as part of consolidating it into search-autocomplete.md.

Whichever of these two PRs merges second should account for the other:

Just flagging for merge sequencing, not a blocker on either PR's own content.

@kimsauce
kimsauce marked this pull request as ready for review September 2, 2026 06:08
Resolves the query-assist.md modify/delete conflict by honoring the
deletion. Preserves PR #7058's intent by adding <MobotCallout/> to the
consolidated search-autocomplete.md, and restores the original page's
Alt+Space / Alt+Esc shortcuts in a new Keyboard shortcuts section.

Also applies audit fixes to search-autocomplete.md (trim description to
<=160 chars, remove em dash, "GA" -> "full release" to match the July
2025 release note) and trims the duplicated AI Parse Assist disambiguation
note in parse-predictable-patterns-using-an-anchor.md to a pointer.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@kimsauce

kimsauce commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator Author

Merge order: this PR (#7061) should merge before #7068 (DOCS-78, Get Started with Search category refactor). They both touch search-autocomplete.md, sidebars.ts, and cid-redirects.json. Once this lands I'll rebase #7068 on main and reconcile search-autocomplete.md there.

@JV0812

JV0812 commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator

Reviewed the full diff and ran a from-scratch yarn build on the branch — no broken links/anchors. Verified the redirect, sidebar removal, and orphaned-image cleanup are all correct, and double-checked the account-preferences icon change is legitimate (the underlying image is a 60×60px icon, not a screenshot, so shrinking it to inline size is correct).

One thing this missed: docs/manage/data-masking.md line 80 still says "Masking is not applied to query-assist suggestions" — this PR retires the "Query Assist" name everywhere else in favor of "Search Autocomplete," but that one reference wasn't updated. Not a broken link (no URL/anchor involved), just a stale term left behind. Checked the whole repo for other "Query Assist" mentions — this is the only one still using the old name.

@JV0812 JV0812 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Verified via full local build (no broken links/anchors) plus a repo-wide check for dangling references to the deleted page/anchors/images — none found. Left one non-blocking comment about a stale terminology reference in data-masking.md.

@kimsauce

kimsauce commented Sep 2, 2026

Copy link
Copy Markdown
Collaborator Author

Re: @JV0812's note about the stale term — docs/manage/data-masking.md isn't in this PR's diff, so GitHub won't take an inline suggestion on it. Here's the exact edit to make directly on the DOCS-1827 branch (Edit file on docs/manage/data-masking.md, line 80):

Current (line 80):

| **Query assist suggestions** | Masking is not applied to query-assist suggestions, regardless of the user's role or data access level. |

Change to:

| **Search autocomplete suggestions** | Masking is not applied to search autocomplete suggestions, regardless of the user's role or data access level. |

Two swaps on that one line: the bold row label Query assist suggestionsSearch autocomplete suggestions, and query-assist suggestionssearch autocomplete suggestions in the cell text. Nothing else in that file needs to change.

removed mention of query assist, Updated the title and description for clarity. Revised sections to improve readability and consistency in terminology regarding data masking rules.
@kimsauce
kimsauce added this pull request to the merge queue Sep 2, 2026
Merged via the queue into main with commit f9ee1b3 Sep 2, 2026
4 checks passed
@kimsauce
kimsauce deleted the DOCS-1827 branch September 2, 2026 07:54
kimsauce added a commit that referenced this pull request Sep 2, 2026
Resolves two conflicts from PR #7061 (Query Assist consolidation):
- search-autocomplete.md: take main's rewritten body and description,
  keep this branch's retitle intent (now just "Search Autocomplete").
- search-large-messages.md: take main's 256KB facts and Known
  limitations section, keep this branch's retitle and sentence-case
  heading.

Label and SEO cleanup on the Get Started with Search docs:
- Drop the inconsistent "Log" disambiguation prefix from titles
  (kept where "log message/data/entry" is the real noun).
- Make the five category-hub titles grammatically parallel; drop
  "How to" and the doubled "Sumo Logic" (the site title template
  already appends it).
- Fix the one gerund sidebar_label ("Exporting" -> "Export Search
  Results"); drop "Log" from "Save a Log Search".
- Rewrite ~20 weak or vague descriptions to specific, ~120-160 char
  summaries.
- Fix pre-existing content bugs surfaced by the audit: swapped Apache
  access/errors descriptions, "Linux server" in the Cisco ASA parser
  doc (frontmatter and body), stale "Windows 2008" reference.
- Make quick-search-collectors-sources.md consistent on "Data
  Collection page".

Reorder two sidebar categories to match 90-day GA4 traffic:
- Search Basics: move built-in-metadata to position 2 (highest-traffic
  page in the section).
- Build Searches: place use-searchable-time and dynamic-parsing above
  the lower-traffic search-modes and search-autocomplete anchors.

Verified with a full yarn build (no broken links or anchors).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed Contributor approved, listed in .clabot file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants