Skip to content

Added ruby how-to examples - #300

Open
Aryex wants to merge 1 commit into
mainfrom
alexl/add-ruby-how-to
Open

Added ruby how-to examples#300
Aryex wants to merge 1 commit into
mainfrom
alexl/add-ruby-how-to

Conversation

@Aryex

@Aryex Aryex commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

Added Ruby documentation for Ruby 1.0.0 release. This covers only the how-to guides.

Related

#299

Content Changes

Ruby tabs added to:

  • Getting connected: installation, client-initialization.
  • Connections: configure-lazy-connection, limit-inflight-requests,
    read-strategy, timeouts-and-reconnect-strategy,
    resilience-best-practices.
  • Commands & scripting: send-batch-commands, execute-custom-commands,
    execute-custom-scripts, load-and-execute-functions.
  • Monitoring: open-telemetry, tracking-resources.
  • Security: authentication, tls.
  • Modules: modules-api/json-module, modules-api/search-module.

Features the Ruby client does not yet support are intentionally omitted. Where a page has a section for an
unsupported feature, the Ruby tab is left out of that section only.

Implementation

Ruby examples were generated per page, then verified by executing every added
snippet against the published valkey-glide-rb 1.0.0.pre.rc2 gem with live
standalone, cluster, and TLS servers (started via cluster_manager.py).

Testing

  • pnpm build runs successfully (110 pages, internal links validated).
  • pnpm format applied.
  • Added Ruby snippets executed against the real 1.0.0.pre.rc2 gem across
    standalone/cluster/TLS/auth.
  • The two modules-api pages were reviewed for API correctness against the
    Ruby client source but not executed (require server modules); JSON/vector
    method names and argument shapes were checked against
    valkey-glide-ruby at v1.0.0-rc2.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one issue.
  • Commit message has a detailed description of what changed and why.
  • All commits are signed off with --signoff flag.
  • pnpm build runs successfully.
  • Links have been checked for validity.
  • Destination branch is correct - main or release
  • Create merge commit if merging release branch into main, squash otherwise.

Signed-off-by: Alex Le <alex.le@improving.com>
@Aryex Aryex self-assigned this Jul 28, 2026
@Aryex Aryex added documentation Improvements or additions to documentation ruby labels Jul 28, 2026
@Aryex Aryex changed the title ruby: added ruby how-to examples Added ruby how-to examples Jul 28, 2026
@Aryex
Aryex marked this pull request as ready for review July 28, 2026 17:33
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 ruby

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant