-
Notifications
You must be signed in to change notification settings - Fork 67
Remove playground, update readme #1423
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
WalkthroughThe 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this 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. - #### RequirementsThis 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
📒 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
What does this PR do?
playground/geo-javascriptexample, which has been migrated to the Meilisearch demos repository: https://github.com/meilisearch/demos/tree/main/src/geo-javascriptPR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.