Skip to content

Commit 6c3a1d2

Browse files
bors[bot]bidoubiwa
andauthored
Merge #366
366: Improve README sections based on docs team suggestions r=bidoubiwa a=bidoubiwa In favor of #365 Co-authored-by: Charlotte Vermandel <[email protected]>
2 parents 91a196a + a6813b4 commit 6c3a1d2

File tree

3 files changed

+16
-12
lines changed

3 files changed

+16
-12
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@
2929

3030
**Meilisearch Rust** is the Meilisearch API client for Rust developers.
3131

32-
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
32+
**Meilisearch** is an open-source search engine. [Learn more about Meilisearch.](https://github.com/meilisearch/meilisearch)
3333

3434
## Table of Contents <!-- omit in TOC -->
3535

3636
- [🎃 Hacktoberfest](#-hacktoberfest)
3737
- [📖 Documentation](#-documentation)
3838
- [🔧 Installation](#-installation)
39-
- [🚀 Getting Started](#-getting-started)
39+
- [🚀 Getting started](#-getting-started)
4040
- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
4141
- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
42-
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
42+
- [⚙️ Contributing](#️-contributing)
4343

4444
## 🎃 Hacktoberfest
4545

@@ -51,7 +51,9 @@ You’d like to contribute? Don’t hesitate to check out our [contributing guid
5151

5252
## 📖 Documentation
5353

54-
See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
54+
This readme contains all the documentation you need to start using this Meilisearch SDK.
55+
56+
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/).
5557

5658
## 🔧 Installation
5759

@@ -92,7 +94,7 @@ curl -L https://install.meilisearch.com | sh
9294

9395
NB: you can also download Meilisearch from **Homebrew** or **APT**.
9496

95-
## 🚀 Getting Started
97+
## 🚀 Getting started
9698

9799
#### Add Documents <!-- omit in TOC -->
98100

@@ -253,7 +255,7 @@ WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extensi
253255

254256
This package only guarantees the compatibility with the [version v0.29.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.29.0).
255257

256-
## ⚙️ Development Workflow and Contributing
258+
## ⚙️ Contributing
257259

258260
Any new contribution is more than welcome in this project!
259261

README.tpl

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,17 @@
2929

3030
**Meilisearch Rust** is the Meilisearch API client for Rust developers.
3131

32-
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
32+
**Meilisearch** is an open-source search engine. [Learn more about Meilisearch.](https://github.com/meilisearch/meilisearch)
3333

3434
## Table of Contents <!-- omit in TOC -->
3535

3636
- [🎃 Hacktoberfest](#-hacktoberfest)
3737
- [📖 Documentation](#-documentation)
3838
- [🔧 Installation](#-installation)
39-
- [🚀 Getting Started](#-getting-started)
39+
- [🚀 Getting started](#-getting-started)
4040
- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
4141
- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
42-
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
42+
- [⚙️ Contributing](#️-contributing)
4343

4444
## 🎃 Hacktoberfest
4545

@@ -51,7 +51,9 @@ You’d like to contribute? Don’t hesitate to check out our [contributing guid
5151

5252
## 📖 Documentation
5353

54-
See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
54+
This readme contains all the documentation you need to start using this Meilisearch SDK.
55+
56+
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/).
5557

5658
## 🔧 Installation
5759

@@ -108,7 +110,7 @@ WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extensi
108110

109111
This package only guarantees the compatibility with the [version v0.29.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.29.0).
110112

111-
## ⚙️ Development Workflow and Contributing
113+
## ⚙️ Contributing
112114

113115
Any new contribution is more than welcome in this project!
114116

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! # 🚀 Getting Started
1+
//! # 🚀 Getting started
22
//!
33
//! ### Add Documents <!-- omit in TOC -->
44
//!

0 commit comments

Comments
 (0)