Skip to content

Remove unused code samples#773

Merged
curquiza merged 1 commit intomainfrom
chore/remove-unused-code-samples
Mar 1, 2026
Merged

Remove unused code samples#773
curquiza merged 1 commit intomainfrom
chore/remove-unused-code-samples

Conversation

@curquiza
Copy link
Member

@curquiza curquiza commented Mar 1, 2026

Summary

  • Removes 27 code samples that were identified as unused by the CI
  • These samples are no longer referenced in the Meilisearch documentation

The unused samples were identified by the documentation CI run: https://github.com/meilisearch/documentation/actions/runs/22537551064/job/65287625968

Removed keys

  • faceted_search_walkthrough_filter_1
  • negative_search_1
  • negative_search_2
  • phrase_search_1
  • search_parameter_guide_attributes_to_search_on_1
  • search_parameter_guide_crop_1
  • search_parameter_guide_crop_marker_1
  • search_parameter_guide_facet_stats_1
  • search_parameter_guide_highlight_1
  • search_parameter_guide_highlight_tag_1
  • search_parameter_guide_hitsperpage_1
  • search_parameter_guide_hybrid_1
  • search_parameter_guide_limit_1
  • search_parameter_guide_matching_strategy_1
  • search_parameter_guide_matching_strategy_2
  • search_parameter_guide_matching_strategy_3
  • search_parameter_guide_offset_1
  • search_parameter_guide_page_1
  • search_parameter_guide_query_1
  • search_parameter_guide_retrieve_1
  • search_parameter_guide_show_matches_position_1
  • search_parameter_guide_show_ranking_score_1
  • search_parameter_guide_sort_1
  • search_parameter_reference_distinct_1
  • search_parameter_reference_locales_1
  • search_parameter_reference_ranking_score_threshold_1
  • search_parameter_reference_retrieve_vectors_1

Summary by CodeRabbit

  • Documentation
    • Removed code samples and examples demonstrating search features, including query construction, search parameters, filtering, faceting, sorting, vector queries, typo tolerance, and ranking configurations from reference documentation.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@curquiza curquiza added the documentation Improvements or additions to documentation label Mar 1, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 1, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2c2032a and 1ecf79e.

📒 Files selected for processing (1)
  • .code-samples.meilisearch.yaml
💤 Files with no reviewable changes (1)
  • .code-samples.meilisearch.yaml

📝 Walkthrough

Walkthrough

A large collection of Meilisearch Rust code sample blocks were removed from a YAML configuration file, eliminating examples for search parameters, query construction techniques, and advanced features like faceting, ranking rules, and vector-based queries.

Changes

Cohort / File(s) Summary
Code Samples Cleanup
.code-samples.meilisearch.yaml
Removed 258 lines of Meilisearch Rust code sample blocks, including examples for query variations, search parameters (attributes_to_search_on, offset, limit, highlight), ranking/sorting, faceting, typo tolerance, and vector-based query features.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 In the warren of code, samples once grew,
Two hundred fifty-eight lines bid adieu,
Clean shelves, tidy docs, a spring-time affair,
The Meilisearch samples float through the air.
Less clutter, more clarity—hop, hop, hurray! 🌱

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Remove unused code samples' accurately reflects the main change: deletion of 27 unused Meilisearch code samples identified by documentation CI.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/remove-unused-code-samples

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

@curquiza curquiza merged commit 82fe194 into main Mar 1, 2026
7 checks passed
@curquiza curquiza deleted the chore/remove-unused-code-samples branch March 1, 2026 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant