You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
366: Improve README sections based on docs team suggestions r=bidoubiwa a=bidoubiwa
In favor of #365
Co-authored-by: Charlotte Vermandel <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,17 +29,17 @@
29
29
30
30
**Meilisearch Rust** is the Meilisearch API client for Rust developers.
31
31
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)
33
33
34
34
## Table of Contents <!-- omit in TOC -->
35
35
36
36
-[🎃 Hacktoberfest](#-hacktoberfest)
37
37
-[📖 Documentation](#-documentation)
38
38
-[🔧 Installation](#-installation)
39
-
-[🚀 Getting Started](#-getting-started)
39
+
-[🚀 Getting started](#-getting-started)
40
40
-[🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
41
41
-[🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
42
-
-[⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
42
+
-[⚙️ Contributing](#️-contributing)
43
43
44
44
## 🎃 Hacktoberfest
45
45
@@ -51,7 +51,9 @@ You’d like to contribute? Don’t hesitate to check out our [contributing guid
51
51
52
52
## 📖 Documentation
53
53
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/).
55
57
56
58
## 🔧 Installation
57
59
@@ -92,7 +94,7 @@ curl -L https://install.meilisearch.com | sh
92
94
93
95
NB: you can also download Meilisearch from **Homebrew** or **APT**.
94
96
95
-
## 🚀 Getting Started
97
+
## 🚀 Getting started
96
98
97
99
#### Add Documents <!-- omit in TOC -->
98
100
@@ -253,7 +255,7 @@ WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extensi
253
255
254
256
This package only guarantees the compatibility with the [version v0.29.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.29.0).
255
257
256
-
## ⚙️ Development Workflow and Contributing
258
+
## ⚙️ Contributing
257
259
258
260
Any new contribution is more than welcome in this project!
Copy file name to clipboardExpand all lines: README.tpl
+7-5Lines changed: 7 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -29,17 +29,17 @@
29
29
30
30
**Meilisearch Rust** is the Meilisearch API client for Rust developers.
31
31
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)
33
33
34
34
## Table of Contents <!-- omit in TOC -->
35
35
36
36
- [🎃 Hacktoberfest](#-hacktoberfest)
37
37
- [📖 Documentation](#-documentation)
38
38
- [🔧 Installation](#-installation)
39
-
- [🚀 Getting Started](#-getting-started)
39
+
- [🚀 Getting started](#-getting-started)
40
40
- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
41
41
- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
42
-
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
42
+
- [⚙️ Contributing](#️-contributing)
43
43
44
44
## 🎃 Hacktoberfest
45
45
@@ -51,7 +51,9 @@ You’d like to contribute? Don’t hesitate to check out our [contributing guid
51
51
52
52
## 📖 Documentation
53
53
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/).
55
57
56
58
## 🔧 Installation
57
59
@@ -108,7 +110,7 @@ WARNING: `meilisearch-sdk` will panic if no Window is available (ex: Web extensi
108
110
109
111
This package only guarantees the compatibility with the [version v0.29.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.29.0).
110
112
111
-
## ⚙️ Development Workflow and Contributing
113
+
## ⚙️ Contributing
112
114
113
115
Any new contribution is more than welcome in this project!
0 commit comments