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

Current example in the README is not much of use #180

Open
kaushalyap opened this issue Oct 15, 2022 · 4 comments
Open

Current example in the README is not much of use #180

kaushalyap opened this issue Oct 15, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@kaushalyap
Copy link

Other

Current example on README create index generated pages by path, this is less useful, why?

  • Users does not want to search queries that match the slug, they want the pages where content matches with their queries.

I know what is shown in README is a dummy example, but it is worth to have real life example like product search. Example using Medusa would be great.

@bidoubiwa
Copy link
Contributor

Hello @kaushalyap ! I agree with your comment, we should definitely provide a better example in the README! Initially we thought about creating an example following this tutorial, where the data inside the markdown would be indexed in Meilisearch.

If you are willing to create the example it would be awesome 🔥 No problem if you don't :)

@kaushalyap
Copy link
Author

Dear @bidoubiwa

Initially we thought about creating an example following this tutorial

That example is better and simpler than pulling data from Medusa, when I figured things out and have enough time I'll give Medusa example a try.

According to my current thinking, the approach would be to generate pages in gatsby and then pull matching product information from medusa using their gatsby plugin and transforming page path and product information to generate the search index.

While there is Meilisearch plugin which automatically generate index with products but we do not have access to slug to have a complete index, while we could update the already created index in front-end using the admin key, this seems like redundant work and security risk. What do you think?

@bidoubiwa bidoubiwa added the support Issues related to support questions. label Oct 17, 2022
@oluademola
Copy link

Hello @kaushalyap

Thank you very much for your suggestion. I am not sure I completely understand your example with Medusa, and it is something we have not considered. However, this being a potential example in the README, the intention would be to create something clear and simple as the previously mentioned tutorial. Let me know your thoughts and if I'm missing anything.

Thanks again.

@kaushalyap
Copy link
Author

@oluademola I agree it should be simple and understandable by majority. So I would suggest going with a markdown page indexing example.

@curquiza curquiza added documentation Improvements or additions to documentation and removed support Issues related to support questions. labels Sep 27, 2023
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants