Skip to content

Commit bf35068

Browse files
meili-botbidoubiwa
authored andcommitted
Update CONTRIBUTING.md
1 parent 62a62a2 commit bf35068

File tree

3 files changed

+41
-100
lines changed

3 files changed

+41
-100
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
1111
## Assumptions
1212

1313
1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) (PR) workflow.**
14-
2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).**
15-
3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
14+
2. **You've read the Meilisearch [documentation](https://www.meilisearch.com/docs) and the [README](/README.md).**
15+
3. **You know about the [Meilisearch community](https://discord.com/invite/meilisearch). Please use this for help.**
1616

1717
## How to Contribute
1818

README.md

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<h4 align="center">
88
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
9-
<a href="https://docs.meilisearch.com">Documentation</a> |
9+
<a href="https://www.meilisearch.com/docs">Documentation</a> |
1010
<a href="https://discord.meilisearch.com">Discord</a> |
1111
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
1212
<a href="https://www.meilisearch.com">Website</a> |
@@ -35,7 +35,7 @@ If you use Angular, React, or Vue, you might want to check out these repositorie
3535
- [meilisearch-react](https://github.com/meilisearch/meilisearch-react/)
3636
- [meilisearch-vue](https://github.com/meilisearch/meilisearch-vue/)
3737

38-
NB: If you don't have any Meilisearch instance running and containing your data, you should take a look at this [getting started page](https://www.meilisearch.com/docs/learn/tutorials/getting_started.html).
38+
NB: If you don't have any Meilisearch instance running and containing your data, you should take a look at this [getting started page](https://www.meilisearch.com/docs/learn/getting_started/installation).
3939

4040
## Table of Contents <!-- omit in toc -->
4141

@@ -83,7 +83,7 @@ const searchClient = instantMeiliSearch(
8383
### Parameters
8484

8585
- `Host` - URL of Meilisearch instance
86-
- `API Key` - Meilisearch access API Key. This can either be a string or a synchronous function that returns a string. ⚠️ Prefer using a key with only [search permissions](https://www.meilisearch.com/docs/learn/security/master_api_keys.html#master-key-and-api-keys) as it is used on your front-end.
86+
- `API Key` - Meilisearch access API Key. This can either be a string or a synchronous function that returns a string. ⚠️ Prefer using a key with only [search permissions](https://www.meilisearch.com/docs/learn/security/master_api_keys#master-key-and-api-keys) as it is used on your front-end.
8787

8888
## 💅 Customization
8989

@@ -137,7 +137,7 @@ Example:
137137

138138
### Primary key
139139

140-
Specify the field in your documents containing the [unique identifier](https://www.meilisearch.com/docs/learn/core_concepts/documents.html#primary-field) (`undefined` by default). By adding this option, we avoid instantSearch errors that are thrown in the browser console. In `React` particularly, this option removes the `Each child in a list should have a unique "key" prop` error.
140+
Specify the field in your documents containing the [unique identifier](https://www.meilisearch.com/docs/learn/core_concepts/documents#primary-field) (`undefined` by default). By adding this option, we avoid instantSearch errors that are thrown in the browser console. In `React` particularly, this option removes the `Each child in a list should have a unique "key" prop` error.
141141

142142
```js
143143
{ primaryKey : 'id' } // default: undefined
@@ -219,7 +219,7 @@ You can use your own HTTP client, for example, with [`axios`](https://github.com
219219

220220
The open-source [InstantSearch](https://www.algolia.com/doc/api-reference/widgets/js/) library powered by Algolia provides all the front-end tools you need to highly customize your search bar environment.
221221

222-
InstantSearch requires that you provide an indexName. The indexName corresponds to the [index `uid`](https://www.meilisearch.com/docs/learn/core_concepts/indexes.html#indexes) in which your document are stored in Meilisearch.
222+
InstantSearch requires that you provide an indexName. The indexName corresponds to the [index `uid`](https://www.meilisearch.com/docs/learn/core_concepts/indexes#indexes) in which your document are stored in Meilisearch.
223223

224224
In `index.html`:
225225

@@ -356,7 +356,7 @@ List of all the components that are available in [instantSearch](https://github.
356356

357357
`instantSearch` is the main component. It manages the widget and lets you add new ones.
358358

359-
- ✅ IndexName: [`uid` of your index](https://www.meilisearch.com/docs/learn/core_concepts/indexes.html#indexes). _required_
359+
- ✅ IndexName: [`uid` of your index](https://www.meilisearch.com/docs/learn/core_concepts/indexes#indexes). _required_
360360
- ✅ SearchClient: Search client, in our case instant-meilisearch. See [customization](#-customization) for details on options. _required_
361361
- ❌ numberLocale: Does not work with both Algoliasearch and instant-meilisearch.
362362
- ✅ searchFunction: Surcharge the search function provided by the search client.
@@ -568,7 +568,7 @@ The `snippet` function returns an attribute from a hit into its snippet form, wh
568568

569569
Note that the attribute has to be added to `attributesToSnippet` in [configuration](#-configure). Highlight is applied on snippeted fields.
570570

571-
Snippeting is called `cropping` in Meilisearch, [more about it here](https://www.meilisearch.com/docs/reference/api/search#search-parameters#attributes-to-retrieve). It is possible to change the size of the snippeting by adding its character size in the attributesToSnippet parameter. <br>
571+
Snippeting is called `cropping` in Meilisearch, [more about it here](https://www.meilisearch.com/docs/reference/api/search#attributes-to-retrieve). It is possible to change the size of the snippeting by adding its character size in the attributesToSnippet parameter. <br>
572572
For example: `"description:40"`.
573573

574574
The `40` value represents the number of characters (rounded down to always have full words) and not the number of words. Thus, the snippet string size is always equal to or lower than `40` characters.
@@ -681,7 +681,7 @@ Alternatively, the parameters can be passed through the [`searchFunction`](https
681681
},
682682
```
683683

684-
[Read the guide on how GeoSearch works in Meilisearch](https://www.meilisearch.com/docs/reference/features/geosearch.html#geosearch).
684+
[Read the guide on how GeoSearch works in Meilisearch](https://www.meilisearch.com/docs/learn/getting_started/filtering_and_sorting#geosearch).
685685

686686
### ❌ Answers
687687

@@ -742,7 +742,7 @@ The `hierarchicalMenu` widget is used to create navigation based on a hierarchy
742742
#### Hierarchical Menu Usage
743743
To make it work with Meilisearch your documents must have a specific structure, an explanation of the structure can [be found here](https://www.algolia.com/doc/api-reference/widgets/hierarchical-menu/js/#requirements).
744744

745-
Contrary to `instantsearch.js`, the hierarchical fields are added in [`filterableAttributes`](https://www.meilisearch.com/docs/reference/api/settings#filterable-attributes#update-filterable-attributes).
745+
Contrary to `instantsearch.js`, the hierarchical fields are added in [`filterableAttributes`](https://www.meilisearch.com/docs/reference/api/settings#filterable-attributes).
746746

747747
Example:
748748
Give the following document structure:
@@ -778,14 +778,13 @@ The `rangeSlider` widget provides a user-friendly way to filter the results, bas
778778
- ✅ attribute: The name of the attribute in the document. _required_.
779779
- ✅ min: The minimum value for the input. _required_
780780
- ✅ max: The maximum value for the input. _required_
781-
- precision: The number of digits after the decimal point to use. Not compatible as only integers work with `rangeSlider`.
781+
- precision: The number of digits after the decimal point to use. Not compatible as only integers work with `rangeSlider`.
782782
- ✅ step: The number of steps between each handle move.
783783
- ✅ pips: Whether to show slider pips (ruler marks).
784784
- ✅ tooltips: Whether to show tooltips. The default tooltips show the raw value.
785785
- ✅ cssClasses: The CSS classes to override.
786786

787-
To be able to use the `rangeSlider` on an attribute, the attribute must be in the[`filterableAttributes`](https://www.meilisearch.com/docs/reference/features/filtering_and_faceted_search.html#configuring-filters) and must contain numeric values.
788-
787+
To be able to use the `rangeSlider` on an attribute, the attribute must be in the[`filterableAttributes`](https://www.meilisearch.com/docs/reference/api/settings#filterable-attributes) and must contain numeric values.
789788

790789
### ✅ Menu
791790

@@ -829,7 +828,7 @@ The `rangeInput` widget allows a user to select a numeric range using a minimum
829828
- ✅ templates: The templates to use for the widget.
830829
- ✅ cssClasses: The CSS classes to override.
831830

832-
To be able to use the `RangeInput` on an attribute, the attribute must be in the[`filterableAttributes`](https://www.meilisearch.com/docs/reference/features/filtering_and_faceted_search.html#configuring-filters) and must contain numeric values.
831+
To be able to use the `RangeInput` on an attribute, the attribute must be in the[`filterableAttributes`](https://www.meilisearch.com/docs/reference/api/settings#filterable-attributes) and must contain numeric values.
833832

834833
### ✅ MenuSelect
835834

@@ -885,7 +884,7 @@ The `RatingMenu` widget lets the user refine search results by clicking on stars
885884
- ✅ templates: The templates to use for the widget.
886885
- ✅ cssClasses: The CSS classes to override.
887886

888-
Contrary to `instantsearch.js`, To be able to use `RatingMenu` the field containing the rating has to be added in the [`filterableAttributes`](https://www.meilisearch.com/docs/reference/api/settings#filterable-attributes#update-filterable-attributes) setting in your index settings.
887+
Contrary to `instantsearch.js`, To be able to use `RatingMenu` the field containing the rating has to be added in the [`filterableAttributes`](https://www.meilisearch.com/docs/reference/api/settings#filterable-attributes) setting in your index settings.
889888

890889
### ✅ ClearRefinements
891890

@@ -1013,7 +1012,7 @@ A sort formula is expressed like this: `index:attribute:order`.
10131012

10141013
`index` is mandatory, and when adding `attribute:order`, they must always be added together.
10151014

1016-
When sorting on an attribute, the attribute has to be added to the [`sortableAttributes`](https://www.meilisearch.com/docs/reference/api/sortable_attributes.html) setting on your index.
1015+
When sorting on an attribute, the attribute has to be added to the [`sortableAttributes`](https://www.meilisearch.com/docs/reference/api/settings#sortable-attributes) setting on your index.
10171016

10181017
Example:
10191018
```js
@@ -1024,24 +1023,11 @@ Example:
10241023

10251024
In this scenario, in the `clothes` index, we want the price to be sorted in an ascending way. For this formula to be valid, `price` must be added to the `sortableAttributes` settings of the `clothes` index.
10261025

1027-
#### Sort by multiple attributes
1028-
When sorting by mutiple fields sort formula is expressed like this: `index:attribute:order,attribute2:order`.
1029-
1030-
Example:
1031-
```js
1032-
[
1033-
{ label: 'Sort By Price And Title', value: 'clothes:price:asc,title:asc' }
1034-
]
1035-
```
1036-
1037-
⚠️ Attributes with comma in their name are not allowed.
1038-
1039-
10401026
#### Relevancy
10411027

1042-
The impact sorting has on the returned hits is determined by the [`ranking-rules`](https://www.meilisearch.com/docs/learn/core_concepts/relevancy.html#ranking-rules) ordered list of each index. The `sort` ranking-rule position in the list makes sorting documents more or less important than other rules. If you want to change the sort impact on the relevancy, it is possible to change it in the [ranking-rule setting](https://www.meilisearch.com/docs/learn/core_concepts/relevancy.html#relevancy). For example, to favor exhaustivity over relevancy.
1028+
The impact sorting has on the returned hits is determined by the [`ranking-rules`](https://www.meilisearch.com/docs/learn/core_concepts/relevancy#ranking-rules) ordered list of each index. The `sort` ranking-rule position in the list makes sorting documents more or less important than other rules. If you want to change the sort impact on the relevancy, it is possible to change it in the [ranking-rule setting](https://www.meilisearch.com/docs/learn/core_concepts/relevancy#relevancy). For example, to favor exhaustivity over relevancy.
10431029

1044-
See [relevancy guide](https://www.meilisearch.com/docs/learn/core_concepts/relevancy.html#relevancy).
1030+
See [relevancy guide](https://www.meilisearch.com/docs/learn/core_concepts/relevancy#relevancy).
10451031

10461032
#### Example
10471033

0 commit comments

Comments
 (0)