Repository navigation
Conversation
Fix invalid or misleading examples for lazy connections, reconnect behavior, connection options, scripting, troubleshooting, and TLS across the supported clients. Signed-off-by: Alex Le <alex.le@improving.com>
Correct client creation, TLS option names, timeout values, and unsupported configuration fields while keeping operation-focused snippets concise. Signed-off-by: Alex Le <alex.le@improving.com>
Verified the examples touched by this PR against the latest client builds (Python/Node/Java/Go 2.6.0-rc3, C# 1.1.0, PHP 1.2.0-rc1, Ruby 1.1.0.pre.rc1) and fixed the remaining problems: - TLS tutorial: the custom-cert example called client.is_connected(), which does not exist, so it raised AttributeError after a successful connection. Initialize client to None and guard close() instead. - Quickstart config: label request_timeout as the request timeout, not the connection timeout; drop the inaccurate "0-15" database range. - Quickstart PHP config: keep only the options the other tabs set. This also removes 'factor' => 2.0, which the extension silently ignored. - Quickstart Python: decode the ping response so it prints PONG, matching the documented output. - Go basic operations: print value.Value() instead of the Result struct. - Go examples: rename the config variable to cfg so it no longer shadows the config package. Signed-off-by: Alex Le <alex.le@improving.com>
Replace the legacy Starlight <Tabs>/<TabItem> client-language tab groups with the <ClientTabs>/<ClientTab> components: - how-to/client-pool.mdx: 6 tab groups (24 tabs) - how-to/isolated-scope.mdx: 3 tab groups (12 tabs) Also remove the unused Tabs/TabItem imports from concepts/client-features/modules.mdx and pubsub-model.mdx. Remaining TabItem usage is for generic choices (Gradle/Maven, sync/async, migration comparisons) rather than client languages. Signed-off-by: Alex Le <alex.le@improving.com>
Drop the Aside import from concepts/client-features/modules.mdx and pubsub-model.mdx; neither page uses the component. Signed-off-by: Alex Le <alex.le@improving.com>
Aryex
force-pushed
the
alexl/docs-catchup-corrections
branch
from
November 5, 2026 19:20
7df9c8a to
926b343
Compare
Aryex
marked this pull request as ready for review
November 5, 2026 19:21
jeremyprime
reviewed
Nov 5, 2026
jeremyprime
reviewed
Nov 5, 2026
jeremyprime
reviewed
Nov 5, 2026
jeremyprime
reviewed
Nov 5, 2026
- Close the client in the quickstart Go connection configuration example. - Decode Python GET and MGET results so they print as strings. - Use port 6379 in the Go connection options example and drop the package clause, matching the other snippets. Signed-off-by: Alex Le <alex.le@improving.com>
jeremyprime
approved these changes
Nov 6, 2026
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Human Overview
This PR correct various code examples in docs as well as update a few missed TabItem to ClientTab.
Summary
Correct examples and guidance that no longer match the current client APIs or runtime behavior.
Issue link
Closes #326. The other fixes come from the local docs gap audit.
Content changes
ClientTabs, and remove unused component imports.Implementation
The changes stay within existing pages and preserve equivalent flows across language tabs. This PR incorporates the still-relevant API corrections from #331, but intentionally omits broad try/catch wrappers from simple operation and configuration snippets. New feature documentation and the pool/scope/recovery updates are in separate drafts.
Testing
pnpm run format:checkpnpm buildChecklist
--signoffflag.pnpm buildruns successfully.main.