Skip to content

Commit 71c4fa4

Browse files
Merge #1507
1507: Readme broken links fixed r=bidoubiwa a=roy9495 # Pull Request ## Related issue Fixes #1505 ## What does this PR do? - Fixes broken links in the README.md ## PR checklist Please check if your PR fulfils the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! Co-authored-by: TATHAGATA ROY <[email protected]>
2 parents 2d2c7f2 + 6c18bd5 commit 71c4fa4

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Output:
185185

186186
### Using search parameters <!-- omit in toc -->
187187

188-
`meilisearch-js` supports all [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) described in our main documentation website.
188+
`meilisearch-js` supports all [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters) described in our main documentation website.
189189

190190
```javascript
191191
await index.search(
@@ -220,7 +220,7 @@ await index.search(
220220

221221
### Custom search with filters <!-- omit in toc -->
222222

223-
To enable filtering, you must first add your attributes to the [`filterableAttributes` index setting](https://docs.meilisearch.com/reference/api/filterable_attributes.html).
223+
To enable filtering, you must first add your attributes to the [`filterableAttributes` index setting](https://www.meilisearch.com/docs/reference/api/settings#filterable-attributes).
224224

225225
```js
226226
await index.updateAttributesForFaceting([
@@ -304,7 +304,7 @@ await index.search(
304304
}
305305
```
306306

307-
Note that to enable faceted search on your dataset you need to add `genres` to the `filterableAttributes` index setting. For more information on filtering and faceting, [consult our documentation settings](https://docs.meilisearch.com/reference/features/faceted_search.html#setting-up-facets).
307+
Note that to enable faceted search on your dataset you need to add `genres` to the `filterableAttributes` index setting. For more information on filtering and faceting, [consult our documentation settings](https://www.meilisearch.com/docs/learn/advanced/faceted_search).
308308

309309
#### Abortable search <!-- omit in toc -->
310310

@@ -376,9 +376,9 @@ This package guarantees compatibility with [version v1.x of Meilisearch](https:/
376376
The following sections in our main documentation website may interest you:
377377

378378
- **Manipulate documents**: see the [API references](https://docs.meilisearch.com/reference/api/documents.html) or read more about [documents](https://docs.meilisearch.com/learn/core_concepts/documents.html).
379-
- **Search**: see the [API references](https://docs.meilisearch.com/reference/api/search.html) or follow our guide on [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html).
379+
- **Search**: see the [API references](https://docs.meilisearch.com/reference/api/search.html) or follow our guide on [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters).
380380
- **Manage the indexes**: see the [API references](https://docs.meilisearch.com/reference/api/indexes.html) or read more about [indexes](https://docs.meilisearch.com/learn/core_concepts/indexes.html).
381-
- **Configure the index settings**: see the [API references](https://docs.meilisearch.com/reference/api/settings.html) or follow our guide on [settings parameters](https://docs.meilisearch.com/reference/features/settings.html).
381+
- **Configure the index settings**: see the [API references](https://docs.meilisearch.com/reference/api/settings.html) or follow our guide on [settings parameters](https://www.meilisearch.com/docs/reference/api/settings#settings_parameters).
382382

383383
This repository also contains [more examples](./examples).
384384

@@ -404,7 +404,7 @@ client.index<T>('xxx').searchGet(query: string, options: SearchParams = {}, conf
404404

405405
### Multi Search
406406

407-
#### [Make multiple search requests](https://docs.meilisearch.com/reference/api/multi-search.html)
407+
#### [Make multiple search requests](https://www.meilisearch.com/docs/reference/api/multi_search#multi-search)
408408

409409
```ts
410410
client.multiSearch(queries?: MultiSearchParams, config?: Partial<Request>): Promise<Promise<MultiSearchResponse<T>>>
@@ -685,159 +685,159 @@ client.index('myIndex').resetPagination(): Promise<EnqueuedTask>
685685

686686
### Synonyms <!-- omit in toc -->
687687

688-
#### [Get synonyms](https://docs.meilisearch.com/reference/api/synonyms.html#get-synonyms)
688+
#### [Get synonyms](https://www.meilisearch.com/docs/reference/api/settings#get-synonyms)
689689

690690
```ts
691691
client.index('myIndex').getSynonyms(): Promise<Synonyms>
692692
```
693693

694-
#### [Update synonyms](https://docs.meilisearch.com/reference/api/synonyms.html#update-synonyms)
694+
#### [Update synonyms](https://www.meilisearch.com/docs/reference/api/settings#update-synonyms)
695695

696696
```ts
697697
client.index('myIndex').updateSynonyms(synonyms: Synonyms): Promise<EnqueuedTask>
698698
```
699699

700-
#### [Reset synonyms](https://docs.meilisearch.com/reference/api/synonyms.html#reset-synonyms)
700+
#### [Reset synonyms](https://www.meilisearch.com/docs/reference/api/settings#reset-synonyms)
701701

702702
```ts
703703
client.index('myIndex').resetSynonyms(): Promise<EnqueuedTask>
704704
```
705705

706706
### Stop words <!-- omit in toc -->
707707

708-
#### [Get stop words](https://docs.meilisearch.com/reference/api/stop_words.html#get-stop-words)
708+
#### [Get stop words](https://www.meilisearch.com/docs/reference/api/settings#get-stop-words)
709709

710710
```ts
711711
client.index('myIndex').getStopWords(): Promise<string[]>
712712
```
713713

714-
#### [Update stop words](https://docs.meilisearch.com/reference/api/stop_words.html#update-stop-words)
714+
#### [Update stop words](https://www.meilisearch.com/docs/reference/api/settings#update-stop-words)
715715

716716
```ts
717717
client.index('myIndex').updateStopWords(stopWords: string[] | null ): Promise<EnqueuedTask>
718718
```
719719

720-
#### [Reset stop words](https://docs.meilisearch.com/reference/api/stop_words.html#reset-stop-words)
720+
#### [Reset stop words](https://www.meilisearch.com/docs/reference/api/settings#reset-stop-words)
721721

722722
```ts
723723
client.index('myIndex').resetStopWords(): Promise<EnqueuedTask>
724724
```
725725

726726
### Ranking rules <!-- omit in toc -->
727727

728-
#### [Get ranking rules](https://docs.meilisearch.com/reference/api/ranking_rules.html#get-ranking-rules)
728+
#### [Get ranking rules](https://www.meilisearch.com/docs/reference/api/settings#get-ranking-rules)
729729

730730
```ts
731731
client.index('myIndex').getRankingRules(): Promise<string[]>
732732
```
733733

734-
#### [Update ranking rules](https://docs.meilisearch.com/reference/api/ranking_rules.html#update-ranking-rules)
734+
#### [Update ranking rules](https://www.meilisearch.com/docs/reference/api/settings#update-ranking-rules)
735735

736736
```ts
737737
client.index('myIndex').updateRankingRules(rankingRules: string[] | null): Promise<EnqueuedTask>
738738
```
739739

740-
#### [Reset ranking rules](https://docs.meilisearch.com/reference/api/ranking_rules.html#reset-ranking-rules)
740+
#### [Reset ranking rules](https://www.meilisearch.com/docs/reference/api/settings#reset-ranking-rules)
741741

742742
```ts
743743
client.index('myIndex').resetRankingRules(): Promise<EnqueuedTask>
744744
```
745745

746746
### Distinct Attribute <!-- omit in toc -->
747747

748-
#### [Get distinct attribute](https://docs.meilisearch.com/reference/api/distinct_attribute.html#get-distinct-attribute)
748+
#### [Get distinct attribute](https://www.meilisearch.com/docs/reference/api/settings#get-distinct-attribute)
749749

750750
```ts
751751
client.index('myIndex').getDistinctAttribute(): Promise<string | void>
752752
```
753753

754-
#### [Update distinct attribute](https://docs.meilisearch.com/reference/api/distinct_attribute.html#update-distinct-attribute)
754+
#### [Update distinct attribute](https://www.meilisearch.com/docs/reference/api/settings#update-distinct-attribute)
755755

756756
```ts
757757
client.index('myIndex').updateDistinctAttribute(distinctAttribute: string | null): Promise<EnqueuedTask>
758758
```
759759

760-
#### [Reset distinct attribute](https://docs.meilisearch.com/reference/api/distinct_attribute.html#reset-distinct-attribute)
760+
#### [Reset distinct attribute](https://www.meilisearch.com/docs/reference/api/settings#reset-distinct-attribute)
761761

762762
```ts
763763
client.index('myIndex').resetDistinctAttribute(): Promise<EnqueuedTask>
764764
```
765765

766766
### Searchable attributes <!-- omit in toc -->
767767

768-
#### [Get searchable attributes](https://docs.meilisearch.com/reference/api/searchable_attributes.html#get-searchable-attributes)
768+
#### [Get searchable attributes](https://www.meilisearch.com/docs/reference/api/settings#get-searchable-attributes)
769769

770770
```ts
771771
client.index('myIndex').getSearchableAttributes(): Promise<string[]>
772772
```
773773

774-
#### [Update searchable attributes](https://docs.meilisearch.com/reference/api/searchable_attributes.html#update-searchable-attributes)
774+
#### [Update searchable attributes](https://www.meilisearch.com/docs/reference/api/settings#update-searchable-attributes)
775775

776776
```ts
777777
client.index('myIndex').updateSearchableAttributes(searchableAttributes: string[] | null): Promise<EnqueuedTask>
778778
```
779779

780-
#### [Reset searchable attributes](https://docs.meilisearch.com/reference/api/searchable_attributes.html#reset-searchable-attributes)
780+
#### [Reset searchable attributes](https://www.meilisearch.com/docs/reference/api/settings#reset-searchable-attributes)
781781

782782
```ts
783783
client.index('myIndex').resetSearchableAttributes(): Promise<EnqueuedTask>
784784
```
785785

786786
### Displayed attributes <!-- omit in toc -->
787787

788-
#### [Get displayed attributes](https://docs.meilisearch.com/reference/api/displayed_attributes.html#get-displayed-attributes)
788+
#### [Get displayed attributes](https://www.meilisearch.com/docs/reference/api/settings#get-displayed-attributes)
789789

790790
```ts
791791
client.index('myIndex').getDisplayedAttributes(): Promise<string[]>
792792
```
793793

794-
#### [Update displayed attributes](https://docs.meilisearch.com/reference/api/displayed_attributes.html#update-displayed-attributes)
794+
#### [Update displayed attributes](https://www.meilisearch.com/docs/reference/api/settings#update-displayed-attributes)
795795

796796
```ts
797797
client.index('myIndex').updateDisplayedAttributes(displayedAttributes: string[] | null): Promise<EnqueuedTask>
798798
```
799799

800-
#### [Reset displayed attributes](https://docs.meilisearch.com/reference/api/displayed_attributes.html#reset-displayed-attributes)
800+
#### [Reset displayed attributes](https://www.meilisearch.com/docs/reference/api/settings#reset-displayed-attributes)
801801

802802
```ts
803803
client.index('myIndex').resetDisplayedAttributes(): Promise<EnqueuedTask>
804804
```
805805

806806
### Filterable attributes <!-- omit in toc -->
807807

808-
#### [Get filterable attributes](https://docs.meilisearch.com/reference/api/filterable_attributes.html#get-filterable-attributes)
808+
#### [Get filterable attributes](https://www.meilisearch.com/docs/reference/api/settings#get-filterable-attributes)
809809

810810
```ts
811811
client.index('myIndex').getFilterableAttributes(): Promise<string[]>
812812
```
813813

814-
#### [Update filterable attributes](https://docs.meilisearch.com/reference/api/filterable_attributes.html#update-filterable-attributes)
814+
#### [Update filterable attributes](https://www.meilisearch.com/docs/reference/api/settings#update-filterable-attributes)
815815

816816
```ts
817817
client.index('myIndex').updateFilterableAttributes(filterableAttributes: string[] | null): Promise<EnqueuedTask>
818818
```
819819

820-
#### [Reset filterable attributes](https://docs.meilisearch.com/reference/api/filterable_attributes.html#reset-filterable-attributes)
820+
#### [Reset filterable attributes](https://www.meilisearch.com/docs/reference/api/settings#reset-filterable-attributes)
821821

822822
```ts
823823
client.index('myIndex').resetFilterableAttributes(): Promise<EnqueuedTask>
824824
```
825825

826826
### Sortable attributes <!-- omit in toc -->
827827

828-
#### [Get sortable attributes](https://docs.meilisearch.com/reference/api/sortable_attributes.html#get-sortable-attributes)
828+
#### [Get sortable attributes](https://www.meilisearch.com/docs/reference/api/settings#get-sortable-attributes)
829829

830830
```ts
831831
client.index('myIndex').getSortableAttributes(): Promise<string[]>
832832
```
833833

834-
#### [Update sortable attributes](https://docs.meilisearch.com/reference/api/sortable_attributes.html#update-sortable-attributes)
834+
#### [Update sortable attributes](https://www.meilisearch.com/docs/reference/api/settings#update-sortable-attributes)
835835

836836
```ts
837837
client.index('myIndex').updateSortableAttributes(sortableAttributes: string[] | null): Promise<EnqueuedTask>
838838
```
839839

840-
#### [Reset sortable attributes](https://docs.meilisearch.com/reference/api/sortable_attributes.html#reset-sortable-attributes)
840+
#### [Reset sortable attributes](https://www.meilisearch.com/docs/reference/api/settings#reset-sortable-attributes)
841841

842842
```ts
843843
client.index('myIndex').resetSortableAttributes(): Promise<EnqueuedTask>
@@ -865,19 +865,19 @@ client.index('myIndex').resetFaceting(): Promise<EnqueuedTask>
865865

866866
### Typo tolerance <!-- omit in toc -->
867867

868-
#### [Get typo tolerance](https://docs.meilisearch.com/reference/api/typo_tolerance.html#get-typo-tolerance)
868+
#### [Get typo tolerance](https://www.meilisearch.com/docs/reference/api/settings#get-typo-tolerance-settings)
869869

870870
```ts
871871
client.index('myIndex').getTypoTolerance(): Promise<TypoTolerance>
872872
```
873873

874-
#### [Update typo tolerance](https://docs.meilisearch.com/reference/api/typo_tolerance.html#update-typo-tolerance)
874+
#### [Update typo tolerance](https://www.meilisearch.com/docs/reference/api/settings#update-typo-tolerance-settings)
875875

876876
```ts
877877
client.index('myIndex').updateTypoTolerance(typoTolerance: TypoTolerance | null): Promise<EnqueuedTask>
878878
```
879879

880-
#### [Reset typo tolerance](https://docs.meilisearch.com/reference/api/typo_tolerance.html#reset-typo-tolerance)
880+
#### [Reset typo tolerance](https://www.meilisearch.com/docs/reference/api/settings#reset-typo-tolerance-settings)
881881

882882
```ts
883883
client.index('myIndex').resetTypoTolerance(): Promise<EnqueuedTask>

0 commit comments

Comments
 (0)