Skip to content

Remove unused code samples#1229

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

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

Conversation

@curquiza
Copy link
Copy Markdown
Member

@curquiza curquiza commented Apr 9, 2026

Removes unused code samples from .code-samples.meilisearch.yaml that are neither referenced in the docs nor in the local config:

  • field_properties_guide_searchable_1
  • rename_an_index_1
  • search_parameter_guide_show_ranking_score_details_1

Flagged by the CI: https://github.com/meilisearch/documentation/actions/runs/24176332506/job/70558505454

Summary by CodeRabbit

  • Documentation
    • Removed three outdated code examples from reference documentation covering searchable attributes, ranking score details, and index renaming operations.

@curquiza curquiza added the documentation Improvements or additions to documentation label Apr 9, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 9, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 02ffcc9a-3e7d-4f05-9bba-6e8b673698e9

📥 Commits

Reviewing files that changed from the base of the PR and between c9bdb42 and 3914533.

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

📝 Walkthrough

Walkthrough

Three code-sample entries were removed from the Meilisearch code-samples YAML file: field_properties_guide_searchable_1, search_parameter_guide_show_ranking_score_details_1, and rename_an_index_1. No replacements were added.

Changes

Cohort / File(s) Summary
Removed Code Samples
.code-samples.meilisearch.yaml
Deleted three standalone code-sample definitions related to searchable field properties, ranking score details display, and index renaming operations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • Remove unused code samples #1216: Also modifies .code-samples.meilisearch.yaml to remove unused Meilisearch code-sample entries, though with a larger set of deletions.

Poem

🐰 Old samples fade like carrots past their prime,
Three entries gone, the cleanup keeps good time,
A tidier file hops toward the light,
Less clutter means the docs feel just right! ✨

🚥 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' directly and accurately summarizes the main change in the pull request, which is the deletion of three unused code sample entries from the configuration file.
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
  • 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 enabled auto-merge April 9, 2026 15:12
@curquiza curquiza disabled auto-merge April 9, 2026 15:12
@curquiza curquiza merged commit c5ec673 into main Apr 9, 2026
11 checks passed
@curquiza curquiza deleted the chore/remove-unused-code-samples branch April 9, 2026 15:12
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