Skip to content

Conversation

@andy-stark-redis
Copy link
Contributor

The task crept a bit, so this might have been better broken down into two or more PRs. Anyway, practical results:

  • Each TCE box now has a linkable anchor, so you can direct people straight to examples rather than the page section that contains them.
  • You can select the client language for a page using a URL parameter (?lang=Python, etc), which is useful when you want to link to a tab for a specific language.
  • There's a new "Copy link" button in the box that grabs the associated link and language URL parameter.
  • We've got two new shortcode parameters for {{< clients-example >}}: description and difficulty. These are mainly to inform AI tools about what to expect from an example, but the description is also shown in the box (useful if you've been directed to the box from a link).
  • AI-friendly metadata automatically gets added to the page during the build. It uses some of the new info to help AI to detect and extract relevant code snippets quickly.

This changes the layout of the TCE boxes a bit, so we should get agreement that this looks OK and is worth having. Only the Strings data type page currently has the description and difficulty parameters added - if we go ahead with this PR then I'll update the existing examples with these parameters.

All feedback welcome :-)

@andy-stark-redis andy-stark-redis self-assigned this Jan 7, 2026
@andy-stark-redis andy-stark-redis added the clients Client library docs label Jan 7, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

DOC-6143

@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

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

The changes function well and they look good, so 👍🏻 from me. I'll leave this as a comment so that others can weigh in.

@dwdougherty dwdougherty requested a review from a team January 7, 2026 14:40
Copy link
Contributor

@cmilesb cmilesb left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@andy-stark-redis
Copy link
Contributor Author

Thanks @dwdougherty and @cmilesb !

@andy-stark-redis andy-stark-redis merged commit 7ab04af into main Jan 8, 2026
8 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-6143-linkable-tces branch January 8, 2026 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants