meilisearch / meilisearch/meilisearch-ruby
Add a wiki
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 224
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
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:
- Initializing a client using an initializer and sharing it across models (or whatever is preferred)
- Using API tokens other than the master key in the client
- Indexing and reindexing using database hooks
- Associating search results with ActiveRecord model items
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the README and existing API documentation to inventory what the SDK already covers. Document the full SDK API and the requested client initialization, API token, indexing and reindexing, and ActiveRecord association patterns; done means these topics and common use cases are covered in the wiki.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100