Skip to content

Commit

Permalink
Merge #262
Browse files Browse the repository at this point in the history
262: Update documentation links to the new documentation website r=brunoocasali a=meili-bot

_This PR is auto-generated._

The automated script generated this PR, it updates all the documentation link to the new documentation.
While the domain name and path to the documentation is updated, most of the links require additional changes.

For example: https://github.com/meilisearch/meilisearch-js/pull/1507/files

Additionally, this script only covers the README.md and the CONTRIBUTING.md. It is possible that documentation links that should be updated are present in order files as well. Please check.

Please ensure every new link points to the relevant page.

Related to meilisearch/integration-guides#257


Co-authored-by: meili-bot <[email protected]>
  • Loading branch information
meili-bors[bot] and meili-bot authored Jun 1, 2023
2 parents 381b628 + edcd3fc commit b9b5efb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume

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.**
2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).**
3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
3. **You know about the [Meilisearch community](https://www.meilisearch.com/docs/learn/what_is_meilisearch/contact.html). Please use this for help.**

## How to Contribute

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<a href="https://discord.meilisearch.com">Discord</a> |
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
<a href="https://www.meilisearch.com">Website</a> |
<a href="https://docs.meilisearch.com/faq">FAQ</a>
<a href="https://www.meilisearch.com/docs/faq">FAQ</a>
</h4>

<p align="center">
Expand Down Expand Up @@ -58,7 +58,7 @@

The whole usage of this gem is detailed in this README.

To learn more about Meilisearch, check out our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
To learn more about Meilisearch, check out our [Documentation](https://www.meilisearch.com/docs/learn/tutorials/getting_started.html) or our [API References](https://www.meilisearch.com/docs/reference/api/).

## 🤖 Compatibility with Meilisearch

Expand All @@ -82,7 +82,7 @@ gem 'meilisearch-rails'

### Run Meilisearch <!-- omit in toc -->

There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/reference/features/installation.html#download-and-launch).

For example, if you use Docker:

Expand Down Expand Up @@ -195,11 +195,11 @@ class Book < ApplicationRecord
end
```

Check the dedicated section of the documentation, for more information on the [settings](https://docs.meilisearch.com/reference/features/settings.html).
Check the dedicated section of the documentation, for more information on the [settings](https://www.meilisearch.com/docs/reference/api/settings#settings_parameters).

## 🔍 Custom search

All the supported options are described in the [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html) section of the documentation.
All the supported options are described in the [search parameters](https://www.meilisearch.com/docs/reference/api/search#search-parameters) section of the documentation.

```ruby
Book.search('Harry', attributes_to_highlight: ['*'])
Expand Down

0 comments on commit b9b5efb

Please sign in to comment.