Merge #602

602: Add yardoc documentation to client.rb r=brunoocasali a=ellnix

# Pull Request

This contains preliminary work on #596 to address the lack of anything more than surface-level documentation on this gem.

## Related issue
Fixes #596

## How to view documentation
1. `gem install yardoc`
2. `yardoc doc`
3. `yardoc server`
4. Visit `localhost:8808`

With live updates:
requires `entr`
- In terminal 1: `ls lib/**/*.rb | entr -c yardoc doc`
- In terminal 2: `yardoc server -r`

## Steps

- [ ] Wait for input on #596
- [ ] Write documentation for other files
- [ ] Add documentation check to Github actions
- [ ] Publish documentation

Co-authored-by: ellnix <[email protected]>

Author: meili-bors[bot]

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-03-31 12:39:31 UTC using RuboCop version 1.71.2.
+# on 2025-04-02 09:32:03 UTC using RuboCop version 1.75.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -30,3 +30,16 @@ Metrics/ParameterLists:
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/meilisearch/index.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/meilisearch/index.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 155