Skip to content

docs: surface Valkey support on the external Redis page#3686

Open
Mukil Loganathan (langchain-infra) wants to merge 2 commits intomainfrom
docs/valkey-external-redis-page
Open

docs: surface Valkey support on the external Redis page#3686
Mukil Loganathan (langchain-infra) wants to merge 2 commits intomainfrom
docs/valkey-external-redis-page

Conversation

@langchain-infra
Copy link
Copy Markdown
Contributor

@langchain-infra Mukil Loganathan (langchain-infra) commented Apr 23, 2026

Summary

Valkey has been officially supported as a drop-in replacement for Redis since LangSmith Self-Hosted v0.14 (see self-hosted-changelog.mdx), but it was barely visible in the self-host docs — mentioned only as a buried Note: bullet on the external Redis page, and not at all on the per-cloud or overview pages.

Changes

src/langsmith/self-host-external-redis.mdx

  • Title + sidebar title renamed to "Connect to an external Redis or Valkey database". URL slug unchanged, so cross-links still resolve.
  • Added intro paragraph calling out Valkey as a drop-in replacement and linking to the Requirements section.
  • Promoted the supported-versions line to a first-class bullet (Redis >= 5, or Valkey 8) instead of a Note: aside.
  • Annotated ElastiCache and Memorystore as "Redis or Valkey".

src/langsmith/aws-self-hosted.mdx

  • ElastiCache card: "Redis for caching" → "Redis or Valkey for caching".
  • Reference-architecture bullet: switched to the top-level ElastiCache product page and spelled out the supported versions (Redis >= 5, Valkey 8).

src/langsmith/gcp-self-hosted.mdx

  • Memorystore card: same subtitle update.
  • Reference-architecture bullet: now links both the Memorystore for Redis and Memorystore for Valkey product pages.

src/langsmith/self-hosted.mdx

  • Datastore table row renamed "Redis" → "Redis / Valkey" (anchor id="redis" preserved for backward-compat).
  • Added a sentence noting Valkey is officially supported as a drop-in replacement.
  • Link label updated to "Connect to external Redis or Valkey".

Scope notes

  • Azure pages intentionally unchanged — there is no Azure managed Valkey service.
  • kubernetes.mdx intentionally unchanged — its Redis mentions are generic architecture references, not provider/version guidance.

Disclosure: drafted with Claude Code assistance.

Test plan

  • make lint_prose passes on all four edited files (verified locally)
  • Preview build shows the new title, the updated cards on the AWS and GCP pages, and the "Redis / Valkey" row on the self-hosted overview
  • Existing anchor links into the external Redis page (#amazon-elasticache, #google-cloud-memorystore, #azure-cache-for-redis, #iam-authentication, #requirements, #redis) still resolve

Valkey has been an officially supported drop-in replacement for Redis
since LangSmith Self-Hosted v0.14, but the only reference on the
external Redis page was a buried inline note in the Requirements list.

- Update the page title and sidebar title to "Connect to an external
  Redis or Valkey database" so it shows up in nav and search.
- Add a dedicated intro paragraph calling out Valkey as a drop-in
  replacement, linking to the Requirements section.
- Promote the supported versions line to a first-class bullet
  (Redis >= 5, or Valkey 8) instead of a "Note:" aside.
- Annotate ElastiCache and Memorystore as Redis-or-Valkey. Azure
  intentionally unchanged — no Valkey variant exists there.
@github-actions github-actions Bot added internal langsmith For docs changes to LangSmith labels Apr 23, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Thanks for opening a docs PR, Mukil Loganathan (@langchain-infra)! When it's ready for review, please add the relevant reviewers:

  • @katmayb or @fjmorris (LangSmith)

Cross-links to the external Redis page weren't enough — a reader
scanning the AWS or GCP self-hosted pages for their infra checklist
could miss that ElastiCache for Valkey and Memorystore for Valkey are
supported.

- AWS self-hosted: card subtitle now reads "Redis or Valkey for
  caching"; ElastiCache reference-architecture bullet lists Redis or
  Valkey and spells out the supported versions (Redis >= 5, Valkey 8).
- GCP self-hosted: same treatment for the Memorystore card and bullet,
  linking to the Memorystore for Valkey product page.
- Self-hosted overview: datastore table row renamed to "Redis /
  Valkey", adds a sentence noting Valkey is a drop-in replacement, and
  updates the link label to "Connect to external Redis or Valkey".

Azure intentionally unchanged — no Azure managed Valkey offering.
@github-actions
Copy link
Copy Markdown
Contributor

Mintlify preview branch generated: preview-docsva-1776908745-0c598b9

Site preview: https://langchain-5e9cc07a-preview-docsva-1776908745-0c598b9.mintlify.app

Changed documentation pages (preview deep links):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal langsmith For docs changes to LangSmith

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant