meilisearch / meilisearch-ruby

Ruby SDK for the Meilisearch API
https://meilisearch.com
MIT License
193 stars 44 forks source link

Add a wiki #541

Open wesharper opened 2 weeks ago

wesharper commented 2 weeks ago

Description The README references a wiki, which doesn't appear to exist. While it's possible to piece together information using the API docs and some trial and error, it would be nice if there were exhaustive docs on the entire SDK api as well as common use cases and patterns including, but not limited to the following:

curquiza commented 5 days ago

We activated the wiki again! And we made it updatable by anyone. Feel free to contribute.

More clue:

Initializing a client using an initializer and sharing it across models (or whatever is preferred)

Rails integration README can help

Using API tokens other than the master key in the client

It's already in the README, it works the same than with API keys when initializing the client. Mayeb we could precise it in the README?

Indexing and reindexing using database hooks

Same, Rails related

Associating search results with ActiveRecord model items

Rails here