Skip to content

Conversation

@Strift
Copy link
Collaborator

@Strift Strift commented Dec 1, 2025

What does this PR do?

PR checklist

Please check if your PR fulfills the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

  • Documentation

    • Updated Geo Search documentation to reference an external geosearch demo instead of local playground example
  • Chores

    • Removed the deprecated geo-javascript playground project and associated configuration files

✏️ Tip: You can customize this high-level summary in your review settings.

@changeset-bot
Copy link

changeset-bot bot commented Dec 1, 2025

⚠️ No Changeset found

Latest commit: a54fee9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR
Some errors occurred when validating the changesets config:
The package or glob expression "@meilisearch/geo-playground" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.

@coderabbitai
Copy link

coderabbitai bot commented Dec 1, 2025

Walkthrough

The PR removes the entire geo-javascript playground directory, including HTML, CSS, JavaScript, configuration, and documentation files. Concurrently, it updates the main package README to replace local playground references with an external geosearch demo link.

Changes

Cohort / File(s) Summary
Main package documentation
packages/instant-meilisearch/README.md
Updated Geo Search section to replace two references to local playground example with external geosearch demo link
Geo playground removal
playgrounds/geo-javascript/.env.example, playgrounds/geo-javascript/.gitignore, playgrounds/geo-javascript/README.md, playgrounds/geo-javascript/index.html, playgrounds/geo-javascript/package.json, playgrounds/geo-javascript/src/app.css, playgrounds/geo-javascript/src/app.js, playgrounds/geo-javascript/src/index.css
Deleted entire geo-javascript playground directory, removing environment variable example, Git ignore rule, documentation, HTML UI scaffolding, npm package manifest, and all styling and initialization logic

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Verify that all references to the local playground have been updated in documentation and that the external demo link is correct and accessible
  • Confirm no other parts of the codebase or documentation reference the removed playground files

Possibly related PRs

  • #1414: Modifies the same geo playground files and geosearch README documentation, representing a conflicting or overlapping change scope
  • #1411: Updates playgrounds/geo-javascript/package.json to bump @meilisearch/instant-meilisearch version, directly conflicts with this PR's removal of the same file

Poem

🐰 The playground once stood tall and bright,
With maps and searches in the night,
But now we point to demos fair,
External paths float through the air! ✨

Pre-merge checks and finishing touches

✅ 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 primary changes: removing the geo-javascript playground and updating the README to reference an external demo instead.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/remove-geo-javascript-playground

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/instant-meilisearch/README.md (1)

750-750: Consolidate the duplicate geosearch demo reference.

The identical geosearch demo link appears twice in the Geo Search documentation section (lines 750 and 779). Consolidating this to a single reference would improve documentation clarity without sacrificing context. For example, retaining it only at line 779 (after the Requirements section) would place it immediately before the Usage example where readers are most likely to need it.

Apply this diff to remove the redundant reference:

- ✅ cssClasses: The CSS classes to override.
-
-Check out our [geosearch demo](https://github.com/meilisearch/demos/tree/main/src/geo-javascript) for a working example.
-
 #### Requirements

This retains the reference where it appears after the complete Requirements section, which is a more natural flow before the Usage examples.

Also applies to: 779-779

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 70f6314 and a54fee9.

📒 Files selected for processing (9)
  • packages/instant-meilisearch/README.md (2 hunks)
  • playgrounds/geo-javascript/.env.example (0 hunks)
  • playgrounds/geo-javascript/.gitignore (0 hunks)
  • playgrounds/geo-javascript/README.md (0 hunks)
  • playgrounds/geo-javascript/index.html (0 hunks)
  • playgrounds/geo-javascript/package.json (0 hunks)
  • playgrounds/geo-javascript/src/app.css (0 hunks)
  • playgrounds/geo-javascript/src/app.js (0 hunks)
  • playgrounds/geo-javascript/src/index.css (0 hunks)
💤 Files with no reviewable changes (8)
  • playgrounds/geo-javascript/src/app.css
  • playgrounds/geo-javascript/src/index.css
  • playgrounds/geo-javascript/README.md
  • playgrounds/geo-javascript/src/app.js
  • playgrounds/geo-javascript/.env.example
  • playgrounds/geo-javascript/index.html
  • playgrounds/geo-javascript/package.json
  • playgrounds/geo-javascript/.gitignore
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: instant-meilisearch end-to-end-tests
  • GitHub Check: autocomplete-client end-to-end-tests

@curquiza curquiza added this pull request to the merge queue Dec 2, 2025
Merged via the queue into main with commit 0e30062 Dec 2, 2025
7 checks passed
@curquiza curquiza deleted the chore/remove-geo-javascript-playground branch December 2, 2025 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants