Skip to content

DOC-6216 code example progression attribute#2702

Merged
andy-stark-redis merged 3 commits intomainfrom
DOC-6216-code-example-progression
Jan 29, 2026
Merged

DOC-6216 code example progression attribute#2702
andy-stark-redis merged 3 commits intomainfrom
DOC-6216-code-example-progression

Conversation

@andy-stark-redis
Copy link
Contributor

A test example for adding a loose order of progression among the code examples in a page (effectively forms a simple dependency graph), which appears to be very beneficial for AI tools. The main thing to check out is the buildsUpon attribute in the {{< client-example >}} shortcodes. Adding these to the existing examples would be a one-off job and then future examples should get suggestions for buildsUpon from autocomplete, or else be easily added as a batch by Augie (which is how I added them for this test page).

It seems a useful feature without too much maintenance burden. If we're OK with it then I'll go ahead and add the buildsUpon attributes to the rest of the examples.

@andy-stark-redis andy-stark-redis requested a review from a team January 28, 2026 16:40
@andy-stark-redis andy-stark-redis self-assigned this Jan 28, 2026
@andy-stark-redis andy-stark-redis added do not merge yet experiment clients Client library docs AI-friendliness Features that help AI tools understand and use the doc pages more easily. labels Jan 28, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 28, 2026

DOC-6216

@github-actions
Copy link
Contributor

@dwdougherty
Copy link
Collaborator

dwdougherty commented Jan 28, 2026

Am I correct in saying that there's no visible element for this PR? I took a peak in Chrome devtools, but I didn't see anything. That said, I'm wasn't exactly sure what I was looking for.

@andy-stark-redis
Copy link
Contributor Author

Am I correct in saying that there's no visible element for this PR? I took a peak in Chrome devtools, but I didn't see anything. That said, I'm wasn't exactly sure what I was looking for.

@dwdougherty Correct, yes - the links between the examples are just done with id attributes in the page, etc. The main issue is really whether the extra parameters in the {{< clients-example >}} are going to be a pain.

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.

IMHO, the shortcode is starting to become a bit unwieldy, but if we continue to lean on AI for example generation, which I haven't had a lot of success doing thus far, then maybe it's not so bad. A politician's answer to be sure.

@andy-stark-redis
Copy link
Contributor Author

@dwdougherty Yeah, perhaps we'd better not add any more to the shortcode. Anyway, thanks for the review :-)

@andy-stark-redis andy-stark-redis merged commit 2a56638 into main Jan 29, 2026
5 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-6216-code-example-progression branch January 29, 2026 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI-friendliness Features that help AI tools understand and use the doc pages more easily. clients Client library docs do not merge yet experiment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants