Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume

## How to Contribute

1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/meilisearch/instant-meilisearch/issues/) or [open a new one](https://github.com/meilisearch/instant-meilisearch/issues/new).
1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/meilisearch/meilisearch-js-plugins/issues/) or [open a new one](https://github.com/meilisearch/meilisearch-js-plugins/issues/new).
2. Once done, [fork the instant-meilisearch repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. Ask a maintainer if you want your issue to be checked before making a PR.
3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository.
5. Make the changes on your branch.
6. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the main instant-meilisearch repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/meilisearch/instant-meilisearch/releases/).
We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/meilisearch/meilisearch-js-plugins/releases/).

## Development Workflow

Expand Down Expand Up @@ -139,7 +139,7 @@ Some notes on GitHub PRs:
The draft PR can be very useful if you want to show that you are working on something and make your work visible.
- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/resources/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
- All PRs must be reviewed and approved by at least one maintainer.
- The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/instant-meilisearch/releases/).
- The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/meilisearch-js-plugins/releases/).

## Release Process (for the internal team only)

Expand Down
1,064 changes: 23 additions & 1,041 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/meilisearch/instant-meilisearch.git"
"url": "https://github.com/meilisearch/meilisearch-js-plugins.git"
},
"workspaces": [
"packages/*",
Expand Down
6 changes: 3 additions & 3 deletions packages/autocomplete-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@

<p align="center">
<a href="https://www.npmjs.com/package/@meilisearch/autocomplete-client"><img src="https://img.shields.io/npm/v/@meilisearch/autocomplete-client.svg" alt="npm version"></a>
<a href="https://github.com/meilisearch/instant-meilisearch/actions"><img src="https://github.com/meilisearch/instant-meilisearch/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
<a href="https://github.com/meilisearch/instant-meilisearch/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
<a href="https://github.com/meilisearch/meilisearch-js-plugins/actions"><img src="https://github.com/meilisearch/meilisearch-js-plugins/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
<a href="https://github.com/meilisearch/meilisearch-js-plugins/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
<a href="https://github.com/meilisearch/meilisearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
<a href="https://ms-bors.herokuapp.com/repositories/48"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
</p>
Expand Down Expand Up @@ -245,7 +245,7 @@ Some `autocomplete` parameters are not working using the meilisearch autocomplet

**Supported Meilisearch versions**:

This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/instant-meilisearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-js-plugins/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.

**Node / NPM versions**:

Expand Down
6 changes: 3 additions & 3 deletions packages/autocomplete-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.2.1",
"private": false,
"description": "The search client to use Meilisearch with autocomplete.js.",
"homepage": "https://github.com/meilisearch/instant-meilisearch/tree/main/packages/autocomplete-client",
"homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/autocomplete-client",
"publishConfig": {
"access": "public"
},
Expand All @@ -28,7 +28,7 @@
"types": "./dist/types/index.d.ts",
"sideEffects": false,
"bugs": {
"url": "https://github.com/meilisearch/instant-meilisearch/issues"
"url": "https://github.com/meilisearch/meilisearch-js-plugins/issues"
},
"files": [
"dist",
Expand All @@ -44,7 +44,7 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/meilisearch/instant-meilisearch.git"
"url": "https://github.com/meilisearch/meilisearch-js-plugins.git"
},
"dependencies": {
"@meilisearch/instant-meilisearch": "*"
Expand Down
2 changes: 1 addition & 1 deletion packages/instant-meilisearch/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@

This is the conventional way of calculating the facet distribution. Similar to Algolia's behavior. If you prefer the old behavior, please consider opening an issue.

See [complete explanation here](https://github.com/meilisearch/instant-meilisearch/issues/884)
See [complete explanation here](https://github.com/meilisearch/meilisearch-js-plugins/issues/884)

- 72de4c8: - Compatibility with the `Index` widget is added.

Expand Down
8 changes: 4 additions & 4 deletions packages/instant-meilisearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@

<p align="center">
<a href="https://www.npmjs.com/package/@meilisearch/instant-meilisearch"><img src="https://img.shields.io/npm/v/@meilisearch/instant-meilisearch.svg" alt="npm version"></a>
<a href="https://github.com/meilisearch/instant-meilisearch/actions"><img src="https://github.com/meilisearch/instant-meilisearch/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
<a href="https://github.com/meilisearch/instant-meilisearch/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
<a href="https://github.com/meilisearch/meilisearch-js-plugins/actions"><img src="https://github.com/meilisearch/meilisearch-js-plugins/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
<a href="https://github.com/meilisearch/meilisearch-js-plugins/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
<a href="https://github.com/meilisearch/meilisearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
<a href="https://ms-bors.herokuapp.com/repositories/48"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
</p>
Expand Down Expand Up @@ -419,7 +419,7 @@ instantsearch.widgets.searchBox({
The `configure` widget lets you provide raw search parameters to the Algolia API without rendering anything.

Because these are the search parameters of AlgoliaSearch and not the InstantSearch parameters, some of them are ignored by InstantSearch.<br>
Since we do not act as AlgoliaSearch on search parameters, detailed compatibility can be found in [this issue](https://github.com/meilisearch/instant-meilisearch/issues/389).<br>
Since we do not act as AlgoliaSearch on search parameters, detailed compatibility can be found in [this issue](https://github.com/meilisearch/meilisearch-js-plugins/issues/389).<br>
This component should only be used if no other component provides the same configuration.

We also suggest looking at [Meilisearch's search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters) to determine how they act.
Expand Down Expand Up @@ -468,7 +468,7 @@ The `voiceSearch` widget lets the user perform a voice-based query.

Search Insights lets you report click, conversion and view metrics.

More details about the subject are [given in this issue](https://github.com/meilisearch/instant-meilisearch/issues/410).
More details about the subject are [given in this issue](https://github.com/meilisearch/meilisearch-js-plugins/issues/410).

Requires InstantSearch v4.8.3 or later.

Expand Down
9 changes: 6 additions & 3 deletions packages/instant-meilisearch/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@
"version": "0.13.2",
"private": false,
"description": "The search client to use Meilisearch with InstantSearch.",
"homepage": "https://github.com/meilisearch/instant-meilisearch",
"homepage": "https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch",
"license": "MIT",
"bugs": {
"url": "https://github.com/meilisearch/instant-meilisearch/issues"
"url": "https://github.com/meilisearch/meilisearch-js-plugins/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/meilisearch/meilisearch-js-plugins.git"
},
"repository": "https://github.com/meilisearch/instant-meilisearch/tree/main/packages/instant-meilisearch",
"publishConfig": {
"access": "public"
},
Expand Down