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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
## Assumptions

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

## How to Contribute

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@

<h4 align="center">
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
<a href="https://docs.meilisearch.com">Documentation</a> |
<a href="https://www.meilisearch.com/docs">Documentation</a> |
<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 @@ -44,7 +44,7 @@

This readme contains all the documentation you need to start using this Meilisearch SDK.

For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs).

## 🔧 Installation

Expand All @@ -71,7 +71,7 @@ Using this crate is possible without [serde](https://crates.io/crates/serde), bu

This crate requires a Meilisearch server to run.

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/learn/getting_started/installation).

For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):

Expand Down Expand Up @@ -121,7 +121,7 @@ fn main() { block_on(async move {
})}
```

With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/tasks#get-task).

#### Basic Search <!-- omit in TOC -->

Expand Down Expand Up @@ -199,7 +199,7 @@ client.index("movies_4").set_filterable_attributes(&filterable_attributes).await

You only need to perform this operation once.

Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-task)).
Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://www.meilisearch.com/docs/reference/api/tasks#get-task).

Then, you can perform the search:

Expand Down
8 changes: 4 additions & 4 deletions README.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@

<h4 align="center">
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
<a href="https://docs.meilisearch.com">Documentation</a> |
<a href="https://www.meilisearch.com/docs">Documentation</a> |
<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 @@ -44,7 +44,7 @@

This readme contains all the documentation you need to start using this Meilisearch SDK.

For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs).

## 🔧 Installation

Expand All @@ -71,7 +71,7 @@ Using this crate is possible without [serde](https://crates.io/crates/serde), bu

This crate requires a Meilisearch server to run.

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/learn/getting_started/installation).

For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):

Expand Down
2 changes: 1 addition & 1 deletion examples/settings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ async fn main() {
.expect("An error happened with the index creation.");

// And now we can update the settings!
// You can read more about the available options here: https://docs.meilisearch.com/learn/configuration/settings.html#index-settings
// You can read more about the available options here: https://www.meilisearch.com/docs/learn/configuration/settings#index-settings
let settings: Settings = Settings::new()
.with_searchable_attributes(["name", "title"])
.with_filterable_attributes(["created_at"]);
Expand Down
14 changes: 7 additions & 7 deletions src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ impl Client {
///
/// Don't put a '/' at the end of the host.
///
/// In production mode, see [the documentation about authentication](https://docs.meilisearch.com/reference/features/authentication.html#authentication).
/// In production mode, see [the documentation about authentication](https://www.meilisearch.com/docs/learn/security/master_api_keys#authentication).
///
/// # Example
///
Expand Down Expand Up @@ -549,7 +549,7 @@ impl Client {

/// Get the API [Keys](Key) from Meilisearch with parameters.
///
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#get-all-keys).
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys).
///
/// # Example
///
Expand Down Expand Up @@ -583,7 +583,7 @@ impl Client {

/// Get the API [Keys](Key) from Meilisearch.
///
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#get-all-keys).
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys).
///
/// # Example
///
Expand Down Expand Up @@ -614,7 +614,7 @@ impl Client {

/// Get one API [Key] from Meilisearch.
///
/// See also [`Client::create_key`], [`Client::get_keys`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#get-one-key).
/// See also [`Client::create_key`], [`Client::get_keys`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-one-key).
///
/// # Example
///
Expand Down Expand Up @@ -646,7 +646,7 @@ impl Client {

/// Delete an API [Key] from Meilisearch.
///
/// See also [`Client::create_key`], [`Client::update_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#delete-a-key).
/// See also [`Client::create_key`], [`Client::update_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#delete-a-key).
///
/// # Example
///
Expand Down Expand Up @@ -681,7 +681,7 @@ impl Client {

/// Create an API [Key] in Meilisearch.
///
/// See also [`Client::update_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#create-a-key).
/// See also [`Client::update_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#create-a-key).
///
/// # Example
///
Expand Down Expand Up @@ -718,7 +718,7 @@ impl Client {

/// Update an API [Key] in Meilisearch.
///
/// See also [`Client::create_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#update-a-key).
/// See also [`Client::create_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#update-a-key).
///
/// # Example
///
Expand Down
5 changes: 2 additions & 3 deletions src/dumps.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
//! - During a dump import, all indexes contained in the indicated `.dump` file are imported along with their associated documents and [settings](crate::settings::Settings).
//! Any existing [index](crate::indexes::Index) with the same uid as an index in the dump file will be overwritten.
//!
//! - Dump imports are [performed at launch](https://docs.meilisearch.com/reference/features/configuration.html#import-dump) using an option.
//! [Batch size](https://docs.meilisearch.com/reference/features/configuration.html#dump-batch-size) can also be set at this time.
//! - Dump imports are [performed at launch](https://www.meilisearch.com/docs/learn/configuration/instance_options#import-dump) using an option.
//!
//! # Example
//!
Expand Down Expand Up @@ -46,7 +45,7 @@ use crate::{client::Client, errors::Error, request::*, task_info::TaskInfo};
impl Client {
/// Triggers a dump creation process.
///
/// Once the process is complete, a dump is created in the [dumps directory](https://docs.meilisearch.com/reference/features/configuration.html#dumps-destination).
/// Once the process is complete, a dump is created in the [dumps directory](https://www.meilisearch.com/docs/learn/configuration/instance_options#dump-directory).
/// If the dumps directory does not exist yet, it will be created.
///
/// # Example
Expand Down
4 changes: 2 additions & 2 deletions src/errors.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ pub struct MeilisearchError {
#[serde(rename = "message")]
pub error_message: String,
/// The error code of the error. Officially documented at
/// <https://docs.meilisearch.com/errors>.
/// <https://www.meilisearch.com/docs/reference/errors/error_codes>.
#[serde(rename = "code")]
pub error_code: ErrorCode,
/// The type of error (invalid request, internal error, or authentication error)
Expand Down Expand Up @@ -115,7 +115,7 @@ impl std::fmt::Display for ErrorType {

/// The error code.
///
/// Officially documented at <https://docs.meilisearch.com/errors>.
/// Officially documented at <https://www.meilisearch.com/docs/reference/errors/error_codes>.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
Expand Down
4 changes: 2 additions & 2 deletions src/indexes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
use std::{collections::HashMap, fmt::Display, time::Duration};
use time::OffsetDateTime;

/// A Meilisearch [index](https://docs.meilisearch.com/learn/core_concepts/indexes.html).
/// A Meilisearch [index](https://www.meilisearch.com/docs/learn/core_concepts/indexes).
///
/// # Example
///
Expand Down Expand Up @@ -996,7 +996,7 @@ impl Index {
Ok(self.primary_key.as_deref())
}

/// Get a [Task] from a specific [Index] to keep track of [asynchronous operations](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html).
/// Get a [Task] from a specific [Index] to keep track of [asynchronous operations](https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations).
///
/// # Example
///
Expand Down
Loading