Skip to content

Remove unused code samples#682

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

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

Conversation

@curquiza
Copy link
Copy Markdown
Member

@curquiza curquiza commented Mar 1, 2026

Summary

These code samples were identified as unused by the CI in the Meilisearch documentation repository.

The following 25 keys have been removed from .code-samples.meilisearch.yaml:

  • faceted_search_walkthrough_filter_1
  • multi_search_federated_1
  • 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_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

These were flagged by the CI run: https://github.com/meilisearch/documentation/actions/runs/22537551064/job/65287625968

Summary by CodeRabbit

  • Documentation
    • Streamlined code examples by removing outdated search parameter references. Updated samples now emphasize core platform functionality including task management and index operations.

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
Copy Markdown

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 3c89121 and 41bd540.

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

📝 Walkthrough

Walkthrough

This change removes a large set of example code blocks from the Meilisearch code samples configuration file, including samples related to search parameters, pagination, faceting, and multi-search functionality, while retaining a smaller subset of core examples.

Changes

Cohort / File(s) Summary
Documentation Examples Cleanup
.code-samples.meilisearch.yaml
Removed 96 lines of example code blocks covering search parameters (hits_per_page, page, offset, limit, retrieve, crop, highlight, etc.), faceting, sorting, pagination, and multi/federated-search examples. Retained core examples including cancel_tasks, swap_indexes, and add_movies_json.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 ✨ With a hop and a bound, the cleanup is done,
Example blocks removed, one by one!
The samples are trimmed, the config now lean,
The cleanest YAML the docs have seen! 📚

🚥 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 accurately summarizes the main change: removing code samples that are unused according to CI checks.
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.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (3c89121) to head (41bd540).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #682   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          809       809           
=========================================
  Hits           809       809           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@curquiza curquiza merged commit 38b7d45 into main Mar 1, 2026
8 checks passed
@curquiza curquiza deleted the chore/remove-unused-code-samples branch March 1, 2026 15:11
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