Skip to content

Conversation

@alhambrav
Copy link
Member

Ticket reference or full description of what's in the PR

Add search default filters craftercms/craftercms#8350

@coderabbitai
Copy link

coderabbitai bot commented Sep 23, 2025

Summary by CodeRabbit

  • Documentation
    • Updated engine reference version to 4.5.0.
    • Added “Search Default Filters” section (since 4.5.0) explaining the defaultFilters.enabled property.
    • Introduced a new navigation entry under Engine Configuration Properties for engine-search-default-filters.
    • Inserted cross-references in common configuration properties and step-by-step guidance.
    • Included a configuration example showing how to enable default filters (crafter.engine.search.defaultFilters.enabled=true).

Walkthrough

Updates engine reference documentation to version 4.5.0 and adds a new section and navigation entry for “Search Default Filters,” documenting the defaultFilters.enabled property with example configuration and cross-references throughout engine configuration docs.

Changes

Cohort / File(s) Summary
Docs: Engine reference updates
source/reference/modules/engine.rst
Bumped displayed version from 4.3.1 to 4.5.0; added “Search Default Filters” section (Since 4.5.0) documenting defaultFilters.enabled with example (crafter.engine.search.defaultFilters.enabled=true); inserted new nav item under Engine Configuration; added references in common properties and guidance sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The pull request title "Add search default filters #8350" is clear, specific, and directly aligned with the changes documented in the raw summary. The title accurately describes the primary change—adding documentation for a new search default filters feature—and includes an issue reference for clarity. The title is concise and would enable a teammate scanning the repository history to quickly understand that this PR adds documentation for search default filters functionality.
Description Check ✅ Passed The pull request description follows the repository's template structure by including the required section "### Ticket reference or full description of what's in the PR" and provides both a brief description ("Add search default filters") and a direct link to the related GitHub issue (#8350). While the description is minimal, it meets the template requirements by supplying a ticket reference and clearly stating what is being added, without being vague or off-topic.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5600fe4 and 3d9e8e2.

📒 Files selected for processing (1)
  • source/reference/modules/engine.rst (3 hunks)
🔇 Additional comments (2)
source/reference/modules/engine.rst (2)

2-2: Version bump looks correct (4.5.0).

No issues spotted.


773-775: Nav entry added correctly.

Anchor resolves to the new section and matches naming/style of nearby entries.

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

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants