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

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
Title Check ✅ Passed The title "Add search default filters #8350" accurately summarizes the primary change—adding search default filters to the documentation—and references the related issue. It is concise, specific, and directly related to the files and changes described in the PR. Including the issue number is slightly noisy but acceptable if the repository uses that convention.
Description Check ✅ Passed The PR description uses the repository template heading and includes the ticket reference and a brief statement "Add search default filters", satisfying the template requirement. This makes the description technically compliant and links reviewers to the issue for details. However, the description is minimal and would benefit from a short summary of the specific documentation changes to aid quick review.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant