meilisearch / documentation

Meilisearch documentation

Meilisearch Documentation

Website | Roadmap | Blog | Documentation | FAQ | Discord

This repository is the documentation for the open-source search engine API Meilisearch.

Contributing

Hey, thank you so much for wanting to contribute! If you'd like to help improve this documentation, we'd love to have you!

For more information, see the contributing overview.

Contact

Feel free to contact us about any questions you may have:

• Join our Discord community.
• Open an issue!

Any suggestion or feedback is highly appreciated. Thank you for your support!

documentation's Issues

Release a documentation for the v0.8.5 tag

In order to release a documentation for the 0.8.5 tag, we need to write some missing documentation to better reflect the state of MeiliSearch API in v0.8.5.

• Renaming criterions
• Only two routes left for synonyms: /GET & /POST
• Release of the web interface for search testing

As a reminder, the v0.8.5 is not considered as breaking

Criteria names changed with the engine rewritte

When I rewrote the core engine algorithm (i.e. v0.8.5-alpha.1 & v0.8.5-beta.1) to improve performances, I take the time to rename the criteria with shorter and clear names.

• sum of typos becomes typo
• number of words becomes words
• words proximity becomes proximity
• sum of words attribute becomes attribute
• sum of words position becomes words position
• exact remains exact

This is just a remainder to update the documentation examples that refers to old names.

Add documentation about tokenization and language support

Add oneline curl setup

See meilisearch/MeiliSearch#347

Download part

In Binary Part (Advanced guide)

• Use tabs instead of multiples parts
• Put "compiling from source code" = "Cargo" at the end

And:

• Find a way to use the same code for the tabs (in QuickStart, Download and MeiliSearch Binary).

Add versioning on documentation

At this time, an external user arriving on the documentation don't know which version of Meilisearch the documentation is for. It could be great to add like on other documentation, the ability to get the version on the navigation bar and to switch easily between them.

Examples

• ReactJS
• VueJS

We prefer the way React handles it.

Proposal

We can use the versioning plugin for Vuepress

By default, the documentation should render the last version. But It's could be cool if we can also have a "master"/"beta" version for the latest documentation commit.

Sub issues

• #193 Add version of MeiliSearch in the header-bar.
• #155 Release a documentation for the v0.8.5 tag
• #96 Create a reminder that the documentation follows the master branch and not the tag

camel case in search query parameter.

The query parameter : timeout_ms is in snake_case.

Useless file?

Is the main_concept/newIndexes.md usefull?
Not sure of that, mainly because of there are french sentences insides, but I need your confirmation before doing a PR (fixing the french sentence or deleting the file) :)

Guide on settings

There are a lot of settings in the setting route. For each setting some information can be found in different guides.

There should be a guide that specifically explains all the settings.

Identifier naming

Currently, we use the term identifier to talk about a document identifier.
We might think about a new name, like primaryKey, a term used by many DB.

Replace "Getting started" by "Introduction"

These two sentences should be replaced by "Introduction"

documentation/guides/README.md

Line 8 in d678956

- [🚀 Getting Started](/guides/getting_started/): your first steps with MeiliSearch!

documentation/guides/getting_started/README.md

Line 1 in d678956

# Getting Started

Document the types MeiliSearch handle

Should we add a page on the documentation to explain how MeiliSearch handle the differents types of value you can use?

For example, the booleans and null today can be pushed into MeiliSearch but wont be take into account for indexation. We should take as a starting point the different data types that JSON handles and explain how MeiliSearch work with them.

Add link to search parameters guide in the API reference

Replace 'dsc' with 'desc'

In the documentation in some examples of the ranking rules there is still written dsc() this has been changed to desc()

Fix links errors on Readme.md

This parts don't look like she should.

https://github.com/meilisearch/documentation/blob/master/README.md#L5
https://github.com/meilisearch/documentation/blob/master/README.md#L16-21
https://github.com/meilisearch/documentation/blob/master/README.md#L24

Create a reminder that the documentation follows the master branch and not the tag

filter documentation needs correction

See github question

Datatypes documentation

Links

Find a way to check bad relative links for the crawler. It means:

• links with no ".md" file in the link redirects to a file like "/guides/advanced_guides/synonyms.md"
• links with no '/' at the end, if the link redirects to a folder like "/guides/getting_started/"

Fix Distinct example

Currently, in the example of the Distinct part, we have this json:

[
  {
    "id": 1,
    "skuid": "abcdef",
    "name": "Really nice Jacket",
    "color": "blue"
  },
  {
    "id": 2,
    "skuid": "abcdef",
    "name": "Really nice Jacket",
    "color": "red"
  },
  {
    "id": 3,
    "skuid": "abcdef",
    "name": "Really nice Jacket",
    "color": "green"
  },
]

Which is wrong because the skuid is a string and MeiliSearch (so far) handles only int and float as a dinstinctField.

Plus, the current documentation does not precise that the field used as a distinctField should be `ranked. But the schema will be removed in the next version, so it might be useless to spend time adding this precision.

Move tuturials menu into resources menu

Move all tutorials and its sub-menus into the resources menu.

Http server version

It could be great to refer the documentation to a specific https server version.

Delete all documents instead of clear all documents

Docker does not allow Uppercase letters

meilisearch/meilisearch#375

8.5 : Synonyms route changed

Create documentation for the changes of synonyms in the 8.5

Add button to slack community in the header of the documentation

• Once we have the link to the meilisearch community slack add it to the header bar. Before GitHub.

Write docker image usage

Write about the docker image usage when MeiliDB#324 is merged

Remove compression

Remove header Encoding

[Clarification] Ranked rule in API Reference

Maybe precise that, to activate a rankingRule on a field, this field should be known as ranked by the schema.

Change index route parameter by uid

fixed by #35

Documentation of integrating MeiliSearch with Vuepress

The doc of MeiliSearch uses Vuepress, which I also use, and I find Vuepress needs a better search solution. Any guide to integrate MeiliSearch with Vuepress? Like a plugin?

Thanks!

Remove Batch route

Not present in MeiliSearch anymore.

Specify that an identifier is required in schema

If an index is created and a schema is provided by the user, it is possible to create an index without specifying any field as an 'identifier'. The problem in that case is that when you try to index data, it will accept the data and provide a modification id, but data is unretrievable afterwards. You don't get any error messages in the process, but can't find the data, which leads to a confusion.

Replace :index by :index_uid

In the documentation at some places you can find :index as a url parameter. This should be renamed to :index_uid.

Write Heroku cookbook

A simple cookbook to use MeiliSearch on Heroku and how to use Heroku and configure it properly with a master api key

heroku ps:scale web=0 -a meilisearch
heroku config:set MEILI_API_KEY=12345 -a meilisearch
heroku ps:scale web=1 -a meilisearch

Docker usage with persistence example

As mentioned in meilisearch/MeiliSearch#387, the documentation should display an example of persistent volume for MeiliSearch.

docker run -it --rm \
    -p 7700:7700 \
    -v $(pwd)/data.ms:/data.ms \
    getmeili/meilisearch

[Clarification] get_all_documents order

The route to get all the document returns the documents in a specific order that is :

• neither the order of the identifier (id)
• nor the order in which I sent the documents

The documents are ordered by hash of the identifier (id). It's not clear in the doc yet and could be confusing :) (it was for me before Kero explained it to me)

Add link checker at build time

Maybe check https://github.com/ulivz/vuepress-plugin-check-md

Create an F.A.Q

[API Reference] Fix DELETE stop-word route with a POST

/!\ After having solved this issue

Add version of MeiliSearch in the header-bar.

In the v0.9.0 branch the version is added at the end of the title.
Per suggestion of quentin, it should be added like on this example :

Change exact criterion to exactness

The name of the exact criterion have been changed to exactness with the v0.9.0 release, the documentation should reflect this

Update processing time in documentation after 0.9.0

The documentation showcases some examples with their relative processing time. Those should be updated with the newer fastest version of MeiliSearch.

Unclear sentence

In this section, there is this sentence:

However, in the case of word to sentence or sentence to sentence

I don't understand it, it looks like a sentence that is not finished :)

getting_started folder

What is the purpose of the "getting_started" folder? Not visible in the documentation via links, but still accessible with the url.
For example:
https://docs.meilisearch.com/getting_started/download.html

Components reusability

Sometime we need to have the same information written twice or more in the documentation.
-> We do not want to maintain two versions of the same thing as it is not DRY

We have to find a way to reuse some components. For example, on the get Quick start we have the same documentation as on the download page.

Vuepress team seems to promote the use of <Content/> but it seems not fully handled.

Rename tags into properties

In the schema definition, we call identifier, ranked ... as tags.
Kero, since the beginning, calls them properties.
This name seems clearer :)

Readme

The Readme is quite weird, especially the Open-source section 😂

• the links "Star" and "Fork" are not visible because like the same sentence
• there is an HTML tag
• ...

And a visible link to MeiliSearch repo could be great, no? 😀

Rename keys into authentication

In the advanced guide, we should rename the keys part into authentication. It would be more clear for people reading the doc and searching ways of managing authentication with MeiliSearch

Add "Run MeiliSearch in production" part

So far, there is no part in the documentation which details how to run properly MeiliSearch in production.

It could include:

• the env variables/options to set
• the good practice to apply, for example with the keys. It means when should the user use which key
• on which server is it possible to deploy: for example do not use Heroku server. We could suggest the manifest we use in K8S.

Feel free to complete this list.