Skip to content

Add Ruby examples to Learn, reference, and overview pages - #299

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

Add Ruby examples to Learn, reference, and overview pages#299
Aryex wants to merge 1 commit into
mainfrom
alexl/add-ruby-learn

Conversation

@Aryex

@Aryex Aryex commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

Add documentations for Ruby client 1.0.0 release and covers:

  • Homepage
  • Overview
  • Learn section
  • Reference section

Issue link

#300

Content Changes

  • Getting Started: quickstart, basic-operations — Ruby tabs for
    install, standalone/cluster connection, and basic command examples.
  • Core Features (concepts): batch-commands, custom-commands,
    valkey-scripting — Ruby tabs for pipelining/transactions, call/call_v,
    and scripting.
  • Reference: connection-options (Ruby option mapping), scripting-reference
  • Troubleshooting: Ruby tab for the connection-timeout example.
  • Shared:
    • supported-languages-buttons
    • New Ruby button
    • astro.config.mjs
    • Ruby entry in the API References sidebar;
    • AGENTS.md Ruby in the supported-languages table plus language-tabs authoring guidance.

Testing

  • pnpm build runs successfully (110 pages, internal links validated).
  • pnpm format applied.
  • All added Ruby snippets executed against the real 1.0.0.pre.rc2 gem.
  • Visual review of the language buttons on the homepage.

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.

@Aryex Aryex self-assigned this Jul 28, 2026
@Aryex Aryex added documentation Improvements or additions to documentation ruby labels Jul 28, 2026
@Aryex Aryex mentioned this pull request Jul 28, 2026
7 tasks
@Aryex
Aryex force-pushed the alexl/add-ruby-learn branch from 1e08d3a to 27b196d Compare July 28, 2026 17:11
@Aryex
Aryex marked this pull request as ready for review July 28, 2026 17:11

@currantw currantw left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed to 27b196d.

Comment thread src/content/docs/commons/supported-languages-buttons.mdx
Comment thread src/content/docs/concepts/client-features/batch-commands.mdx
Comment thread src/content/docs/concepts/client-features/batch-commands.mdx Outdated
Comment thread src/content/docs/concepts/client-features/client-side-caching.mdx
Comment thread AGENTS.md
Comment thread src/content/docs/concepts/client-features/valkey-scripting.mdx Outdated
Comment thread src/content/docs/concepts/client-features/valkey-scripting.mdx
Comment thread src/content/docs/concepts/client-features/valkey-scripting.mdx Outdated
Comment thread src/content/docs/reference/connection-options.mdx Outdated
Comment thread src/content/docs/reference/scripting-reference.mdx Outdated
@Aryex

Aryex commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator Author

@currantw I have removed the unnecessary comments.

On the Ruby scripting examples. I decided to remove them. The existing docs is about using the Script class which is a GLIDE interface not implemented in Ruby yet. Added valkey-io/valkey-glide-ruby#206 to track this.

@Aryex
Aryex requested a review from currantw July 30, 2026 18:00
Comment thread src/content/docs/concepts/client-features/valkey-scripting.mdx

@currantw currantw left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed to adf96e0.
A few remaining comments.

@Aryex
Aryex requested a review from currantw July 30, 2026 21:27

@currantw currantw left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good ✅

@Aryex
Aryex force-pushed the alexl/add-ruby-learn branch from 926f955 to 8da9c87 Compare July 30, 2026 22:01
@currantw
currantw self-requested a review July 31, 2026 16:50
Signed-off-by: Alex Le <alex.le@improving.com>
@Aryex
Aryex force-pushed the alexl/add-ruby-learn branch from 8da9c87 to 845109e Compare July 31, 2026 16:54
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.

2 participants