meilisearch / meilisearch/documentation
Review code sample changes
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 174
- Forks
- 276
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 6
Description
We have not been very good at keeping track of code sample updates outside of those related to new versions. This might have lead to a mismatch between curl and SDK examples.
We need to compile a list of all PRs that touched the code samples file since July 2023, then notify @meilisearch/integration-team.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by identifying the code samples file and reviewing its pull request history since July 2023. Compile every PR that changed it, check for mismatches between curl and SDK examples, and notify @meilisearch/integration-team with the resulting list.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100