Skip to content

Remove useless code samples#766

Merged
curquiza merged 1 commit intomainfrom
remove-useless-code-samples
Feb 10, 2026
Merged

Remove useless code samples#766
curquiza merged 1 commit intomainfrom
remove-useless-code-samples

Conversation

@curquiza
Copy link
Member

@curquiza curquiza commented Feb 10, 2026

Summary by CodeRabbit

  • Documentation
    • Removed sample code blocks from documentation to streamline guides.

@curquiza curquiza added skip-changelog The PR will not appear in the release changelogs maintenance Anything related to maintenance (CI, tests, refactoring...) labels Feb 10, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 10, 2026

📝 Walkthrough

Walkthrough

This pull request removes 355 lines of code sample blocks from the .code-samples.meilisearch.yaml documentation file. The changes consolidate and prune numerous sample code examples across various features including filtering, settings, typo tolerance, security, embeddings, and more, reducing documentation redundancy.

Changes

Cohort / File(s) Summary
Documentation Samples Consolidation
.code-samples.meilisearch.yaml
Removal of 355 lines containing duplicate or redundant sample code blocks across multiple feature categories (documents filtering, settings, typo tolerance, security, embeddings, webhooks, and getting started guides).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Snip, snip, hoard no more!
Sample code blocks by the score,
Consolidated with care so deep,
Only essentials the docs shall keep! ✂️

🚥 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 describes the main change: removal of code samples from the YAML documentation 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
  • Post copyable unit tests in a comment
  • Commit unit tests in branch remove-useless-code-samples

No actionable comments were generated in the recent review. 🎉


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

@curquiza curquiza merged commit 3fa148e into main Feb 10, 2026
7 of 8 checks passed
@curquiza curquiza deleted the remove-useless-code-samples branch February 10, 2026 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Anything related to maintenance (CI, tests, refactoring...) skip-changelog The PR will not appear in the release changelogs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant