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

How does lazy index impact the documentation #583

Closed
bidoubiwa opened this issue Nov 4, 2020 · 2 comments
Closed

How does lazy index impact the documentation #583

bidoubiwa opened this issue Nov 4, 2020 · 2 comments

Comments

@bidoubiwa
Copy link
Contributor

bidoubiwa commented Nov 4, 2020

With the arrival of lazy index meilisearch/meilisearch#918 we have to consider how it will impact the documentation.

Should indexes be put to the background since their knowledge is not essential to working with MeiliSearch?

This can be done through different changes:

@dichotommy
Copy link
Contributor

I think this change is intended to simplify things for lower-level users by hiding indexes "under the hood", but in my opinion there is only so far we can go in this direction, since even adding or accessing documents requires an index ID and many important settings are also tied to indexes.

Here is what I think of the proposed changes:

  • In getting started, explicit index creation should be briefly mentioned, maybe in a single sentence, but not demonstrated.
  • In the main concept guide, we should definitely add an implicit vs. explicit comparison section similar to MongoDB's. Implicit: default option, simple, less code. Explicit: more error-proof.
  • In terms of the sidebar order, I think Documents and Indexes should just be switched both in Main Concepts and API References.

@dichotommy
Copy link
Contributor

Closing this because all suggestions (sidebar order aside) have either been implemented, or created as separate issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants