Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
📝 WalkthroughWalkthroughAdded comprehensive documentation for a new experimental "Search rules" feature that enables curating search results by pinning documents based on query text or time-window conditions. Includes overview, getting-started guide, how-to guides, advanced behavior documentation, and navigation updates. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
capabilities/search_rules/advanced/pinning_behavior.mdx (1)
31-31: Rephrase to avoid meta-language in user-facing documentation.The sentence "Describe it as a case-insensitive literal substring match..." sounds like internal guidance for documentation writers rather than direct explanation to users.
✍️ Suggested rewording
-The query condition `contains` is a strict substring match. Describe it as a case-insensitive literal substring match, not as fuzzy, semantic, or pattern-aware matching. +The query condition `contains` performs a case-insensitive literal substring match. It is not a fuzzy, semantic, or pattern-aware match.As per coding guidelines: Prefer short, direct sentences and avoid jargon when a simpler term exists in documentation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@capabilities/search_rules/advanced/pinning_behavior.mdx` at line 31, The sentence currently uses meta-documentation language; update the user-facing description of the query operator `contains` to a short, direct phrase such as "Performs a case-insensitive literal substring match" (avoid words like "describe" or internal guidance), and replace the existing sentence so the docs state plainly what `contains` does without jargon or meta-instructions.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@capabilities/search_rules/advanced/pinning_behavior.mdx`:
- Line 31: The sentence currently uses meta-documentation language; update the
user-facing description of the query operator `contains` to a short, direct
phrase such as "Performs a case-insensitive literal substring match" (avoid
words like "describe" or internal guidance), and replace the existing sentence
so the docs state plainly what `contains` does without jargon or
meta-instructions.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8f7b2d68-df5f-436f-b8d8-7c931e56f276
📒 Files selected for processing (8)
capabilities/overview.mdxcapabilities/search_rules/advanced/pinning_behavior.mdxcapabilities/search_rules/getting_started.mdxcapabilities/search_rules/how_to/pinning_patterns.mdxcapabilities/search_rules/overview.mdxcapabilities/search_rules/reference.mdxconfig/navigation.jsonresources/help/experimental_features_overview.mdx
- Overview now follows the capability-overview pattern (When to use, How it works with a mermaid diagram, Key concepts, Use cases, Current scope, Next steps) and drops the standalone Rule structure JSON block in favor of a narrative Key concepts section. - Getting started gets a Cloud UI walkthrough with 6 dashboard screenshots (activate add-on, create rule, manage rule, add condition, add pin, rules list), followed by the same flow via the API. Generic Prerequisites block dropped. - How-to switched from FAQ-style "How do I..." headings to task-oriented ones to match other capability how_to pages. - Advanced: storage model replaces the duplicated "Current scope" section; meta-language around the contains matcher rewritten as plain prose. - Current scope mentions boosting, demoting, and burying as planned future actions, and links to book a call for use cases not yet covered. - reference.mdx removed; the auto-generated API reference in the References tab is the source of truth.
Replace the monolithic pinning_patterns page with six task-oriented how-to pages (pin one, pin multiple, curate empty query, schedule promotion, list and filter, pause a rule) and point every API reference card to the correct operation-level URL.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
capabilities/search_rules/how_to/pause_a_rule.mdx (1)
6-6: Split this long intro sentence for readability.Line 6 is doing too much in one pass. Breaking it into 2–3 shorter sentences will make the setup easier to scan.
As per coding guidelines, “Prefer shorter sentences; if a sentence runs over approximately 40 words, consider splitting or simplifying.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@capabilities/search_rules/how_to/pause_a_rule.mdx` at line 6, The intro sentence beginning "Sometimes you need to stop a rule from applying without losing its configuration..." is too long; split it into 2–3 shorter sentences for readability: 1) state the situations (campaign ended early, pinned doc review, misbehaving rule) as a short sentence or list, 2) follow with a separate sentence explaining that flipping a rule to inactive stops it from firing at search time while preserving conditions, actions, and metadata, and 3) optionally add a final short sentence noting you can reactivate it later with one click or one API call; update the paragraph containing that long sentence accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@capabilities/search_rules/how_to/curate_empty_query.mdx`:
- Around line 38-40: The explanation for the "Query is empty" condition
currently only mentions missing `q` or `""`; update the text for the `Query is
empty` condition to also state that it matches whitespace-only `q` values (e.g.,
`" "`), so the behavior is consistent with the description later (Line 98) and
users understand that blank/whitespace-only queries are treated as empty; edit
the sentence that currently reads "The condition simply asserts that the search
request has no `q` value, or that `q` is an empty string." to include
whitespace-only `q` values as well.
In `@capabilities/search_rules/how_to/list_and_filter_rules.mdx`:
- Around line 49-50: Update the example filter pattern under the
attributePatterns key from "promo*" to "promo-*" so it matches the documented
rule ID prefix "promo-"; locate the JSON snippet where attributePatterns is
defined (the example with "attributePatterns": ["promo*"]) and replace the value
accordingly (also apply the same change to the other occurrence referenced
around the later example).
---
Nitpick comments:
In `@capabilities/search_rules/how_to/pause_a_rule.mdx`:
- Line 6: The intro sentence beginning "Sometimes you need to stop a rule from
applying without losing its configuration..." is too long; split it into 2–3
shorter sentences for readability: 1) state the situations (campaign ended
early, pinned doc review, misbehaving rule) as a short sentence or list, 2)
follow with a separate sentence explaining that flipping a rule to inactive
stops it from firing at search time while preserving conditions, actions, and
metadata, and 3) optionally add a final short sentence noting you can reactivate
it later with one click or one API call; update the paragraph containing that
long sentence accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: eed99571-d71d-47ea-936d-55990f06d118
⛔ Files ignored due to path filters (6)
assets/images/cloud-search-rules/01-activate-addon.pngis excluded by!**/*.pngassets/images/cloud-search-rules/02-create-first-rule.pngis excluded by!**/*.pngassets/images/cloud-search-rules/03-manage-rule.pngis excluded by!**/*.pngassets/images/cloud-search-rules/04-add-condition.pngis excluded by!**/*.pngassets/images/cloud-search-rules/05-add-pin.pngis excluded by!**/*.pngassets/images/cloud-search-rules/06-rules-list.pngis excluded by!**/*.png
📒 Files selected for processing (10)
capabilities/search_rules/advanced/pinning_behavior.mdxcapabilities/search_rules/getting_started.mdxcapabilities/search_rules/how_to/curate_empty_query.mdxcapabilities/search_rules/how_to/list_and_filter_rules.mdxcapabilities/search_rules/how_to/pause_a_rule.mdxcapabilities/search_rules/how_to/pin_multiple_results.mdxcapabilities/search_rules/how_to/pin_one_result_for_query.mdxcapabilities/search_rules/how_to/schedule_promotion.mdxcapabilities/search_rules/overview.mdxconfig/navigation.json
✅ Files skipped from review due to trivial changes (7)
- config/navigation.json
- capabilities/search_rules/how_to/pin_one_result_for_query.mdx
- capabilities/search_rules/how_to/schedule_promotion.mdx
- capabilities/search_rules/how_to/pin_multiple_results.mdx
- capabilities/search_rules/overview.mdx
- capabilities/search_rules/advanced/pinning_behavior.mdx
- capabilities/search_rules/getting_started.mdx
Comment on lines
+38
to
+40
| `Query is empty` has no additional fields to fill. The condition simply asserts that the search request has no `q` value, or that `q` is an empty string. | ||
|
|
||
| Click **Add condition** to save. |
There was a problem hiding this comment.
Include whitespace-only queries in the condition explanation.
This section says Query is empty matches missing q or "", but Line 98 also says it matches whitespace-only q. Add that here too so behavior is stated consistently in one place.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@capabilities/search_rules/how_to/curate_empty_query.mdx` around lines 38 -
40, The explanation for the "Query is empty" condition currently only mentions
missing `q` or `""`; update the text for the `Query is empty` condition to also
state that it matches whitespace-only `q` values (e.g., `" "`), so the
behavior is consistent with the description later (Line 98) and users understand
that blank/whitespace-only queries are treated as empty; edit the sentence that
currently reads "The condition simply asserts that the search request has no `q`
value, or that `q` is an empty string." to include whitespace-only `q` values as
well.
Member
|
@YoEight, can you confirm that the content is still valid? I've made a few changes:
|
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
2 participants
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.
Description
Add documentation for the (dynamic) search rules experimental feature.
Checklist
For internal Meilisearch team member only:
For external maintainers
Summary by CodeRabbit