meilisearch/meilisearch-rust

feat(docs): Fill in missing [lang] SDK examples

ryanrussell opened this issue · 5 comments

ryanrussell commented

Goal

Fill in missing Rust [lang] examples in the docs.

Problem

This was inspired by finding that the facets example was missing a Rust tab.

This likely exists with other example and language combinations

Background

Just noticed there some rust sdk snippets in the docs examples are missing:
https://docs.meilisearch.com/reference/api/search.html#facets

It would be nice to have a 'Rust' tab using the Rust SDK for every example.

image

It looks like the examples are generated from this yaml.

I do see a reference to the rust code samples, perhaps this is a small tweak to include these? Rust Code Examples

I am still tracing down the docs build workflow to understand how this could/should be added.

Solution

It sounds like a path forward would be to create a matrix of all the examples and languages, to see which ones are missing.

Open to any other solutions or advice from people with more knowledge of the docs build process.

ryanrussell commented

There are other Rust examples in the docs, it's just the facets example in Rust

Is there already a little script or test somewhere that checks all the examples in all the languages and creates a matrix of which one(s) are missing?

This could be filled out in a straightforward manner if there was a grid like that...

Happy to help fill it in, but don't want to duplicate work that may have already been done!

  • 👍1
dichotommy commented

Hi @ryanrussell , thank you for creating an issue and trying to troubleshoot a solution. I really appreciate your active engagement with our docs 🙏🏻

We are aware of this issue. The Rust SDK is currently missing the following code samples:

faceted_search_facets_1
search_parameter_guide_show_matches_position_1

You may also notice that several code samples related to the faceting and pagination settings objects are missing for Rust. This is because the Rust SDK has yet to be updated for the most recent release of Meilisearch (v0.28), which is when these settings were added. These samples will be added as soon as the next version of the Rust SDK is released 👌🏻

Signal to @meilisearch/integration-team that the two samples mentioned above will need to be added separately from the new version PR.

I will transfer your issue to the Rust repository so that our team can take care of it. Thanks again!

p.s. The output of the build command for the documentation site should include all missing code samples separated by SDK. In case you were curious 😉

  • 👍1
  • ❤️1
bidoubiwa commented

Hello @ryanrussell as soon as this PR #297 and this PR #298 are merged, I ll release the new version of this SDK with a version compatible with meilisearch v0.28.1 !

  • 👍1
ryanrussell commented

You guys are doing awesome things!

I will keep an eye on this to learn more about how these examples for various SDK's get integrated into the docs site.... so that if I see details like this in the future, it's a simple PR to help fill in.

Best,
Ryan

  • ❤️1
bidoubiwa commented

Hey @ryanrussell

Since the repository is now compatible with v0.28.0, the code-samples are up to date on the documentation :)

Closing as it is fixed.

  • 👍2