Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a wiki #541

Open
wesharper opened this issue Jun 14, 2024 · 1 comment
Open

Add a wiki #541

wesharper opened this issue Jun 14, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@wesharper
Copy link

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
@curquiza
Copy link
Member

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

@curquiza curquiza added the documentation Improvements or additions to documentation label Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants