meilisearch / meilisearch/meilisearch-java

Code sample revision after refactor

Open
#478 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
Java
Stars
245
Forks
152
PR merge metrics
No merged PRs in 30d

Description

**Description**
After the revision of this SDK, the `code-samples.meilisearch.yaml` will need a revision of each method to ensure that the method still exists and still work as expected in the sample.

**Notes**
This issue should be implemented before the resolution of #420

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with code-samples.meilisearch.yaml and compare each sample method with the revised Java SDK API. Verify that every referenced method still exists and works as shown; completion means all samples are updated consistently before resolving #420.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.