Skip to content

Remove unused code samples#945

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

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

Conversation

@curquiza
Copy link
Member

@curquiza curquiza commented Mar 1, 2026

Summary

  • Removes 23 code sample entries that were identified as unused by the CI
  • These samples are no longer referenced by the Meilisearch documentation build

Context

The following samples were flagged as unused in this CI run: https://github.com/meilisearch/documentation/actions/runs/22537551064/job/65287625968

Removed keys:

  • faceted_search_walkthrough_filter_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

Test plan

  • Verify the YAML file remains valid after removals
  • Confirm the documentation CI no longer reports these as unused samples

Summary by CodeRabbit

  • Documentation
    • Streamlined code examples by removing extensive sample blocks for advanced search parameters and related features, including query, offset, limit, retrieve, crop, highlight, and facet configurations
    • Retained core examples for settings updates, synonym handling, typo tolerance, and facet operations

@curquiza curquiza added the documentation Improvements or additions to documentation label Mar 1, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 1, 2026

Caution

Review failed

The pull request is closed.

ℹ️ 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 c78e0ca and 24af5a6.

📒 Files selected for processing (1)
  • .code-samples.meilisearch.yaml

📝 Walkthrough

Walkthrough

A YAML file containing Meilisearch code samples has been cleaned up, with 91 lines of example code blocks removed. Deleted examples cover search parameters like query, offset, limit, crop, highlight, matching strategies, and facet configurations, while retained samples focus on core operations like settings updates, synonym handling, and typo tolerance.

Changes

Cohort / File(s) Summary
Meilisearch Code Samples
.code-samples.meilisearch.yaml
Removed 91 lines of example code blocks covering advanced search parameters (query, offset, limit, retrieve, crop, highlight), matching strategies, ranking scores, and facet-related workflows. Retained examples for core operations remain intact.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 With whisker-flicks, old samples fade away,
The garden grows cleaner, less cluttered each day,
We hop through the code, removing the dust,
Keeping only the gems that we trust! 🌟

✨ 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 be39947 into main Mar 1, 2026
2 of 3 checks passed
@curquiza curquiza deleted the chore/remove-unused-code-samples branch March 1, 2026 15:25
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