Conversation
Split the 4 overlapping categories (Search Basics, How to Use the Search Page, Build Searches, Suggested Searches) into 5 clearer ones: Search Basics, Build Searches, Search Results, Manage Searches, and Suggested Searches. Docs are regrouped by category without moving any files on disk, so no URLs change and no redirects are needed. Also reorders items within each category to teach fundamentals before edge cases (e.g. Search Modes and Search Autocomplete now lead Build Searches; Comments in Search Queries moves to the end of Search Basics since it depends on already knowing how to write a query). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Sharpen titles so each doc makes sense out of context (e.g. as an Algolia search result), fix sentence-case heading violations, and update cross-references and index-page card text to match the new titles. Also fixes a few awkward or inaccurate sentences flagged during review (e.g. Search Modes' intro, which previously only described Basic Mode). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
… docs Both were short, closely-related docs that made more sense as sections of their parent pages: - Add a Saved Search to Favorites -> merged into Save a Search as "Add a saved search to Favorites" - Share a Link to a Specific Message -> merged into Share a Link to a Search as "Share a link to a specific message" Updates cid-redirects.json (retargets 2 existing legacy redirects and adds 2 new ones for the retired /docs URLs) and fixes the remaining cross-reference in get-started/library.md. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…x content bugs Sidebar and navigation: - Reorder items within all 5 Get Started with Search categories using 90-day GA4 pageview data, keeping explicitly-fixed pedagogical anchors in place (orientation pages first, Search Modes before Autocomplete before Dynamic Parsing, Best Practices last in Build Searches, Comments last in Search Basics) - Sync all 5 index-page TOC card orders to match - Split the non-TOC content out of search-page/index.md and build-search/index.md into new about-search-page.md and about-build-search.md pages, added to sidebars.ts and given proper titles/intros/cross-links (about-build-search.md also had its "Write efficient search queries" section cut since it fully duplicated best-practices-search.md; rescoped to its unique content) Structure and content fixes: - Add missing H2 sections to 9 docs that had none (quick-search- collectors-sources, search-autocomplete, view-traces-search-results, change-time-range-in-histogram, search-from-field-browser, show-hide-fields-in-field-browser, log-level, pin-a-search, search-highlighting); pin-a-search.md and search-from-field-browser.md also had their heading levels promoted to fix an H1-to-H4/H3 skip - Add missing intro paragraph to set-messages-tab-preferences.md and de-duplicate its "Sort by" / "View n messages per page" bullets - Fix log-level.md's frontmatter description, which was copy-pasted from an unrelated doc - Trim duplicated content between set-time-range.md and time-range-expressions.md (DOCS-1830 scope), and cross-link both to the canonical time-reference.md doc for time zone details - Rewrite pause-cancel-search.md's awkward intro and apply the "Log Search page" branding decision - Change "Best approach" to "Recommended" in best-practices-search.md - Add a missing meter-icon (Scan Estimates) row to about-search-page.md's UI reference table - Retitle wildcards-in-full-text-searches.md and search-modes.md with clearer value props Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
This pull request reorganizes the "Get Started with Search" documentation section (DOCS-78):
add-saved-search-to-favorites.md→save-search.md;share-message-link.md→share-link-to-search.md) with matchingcid-redirects.jsonentriesabout-search-page.md/about-build-search.mdpagesset-time-range.mdandtime-range-expressions.md, and fixes several smaller content bugs found along the way (a copy-pasted description, duplicate bullets, an undocumented UI icon, awkward phrasing)Verified against a clean
yarn build(no broken links/anchors) throughout.Not yet addressed from the ticket (flagging for a follow-up pass):
?<field_name>regex named-capture syntax, which is unrelated to?as a wildcard)Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-78