Repository navigation
DOC-7055: Migrate develop/data-types/streams+strings+timeseries to render hooks - #3970
Merged
Merged
Conversation
…ed callouts The DOC-6909 note/warning/tip/info/alert -> `> [!TYPE]` blockquote converter only matched the angle-bracket `{{< note >}}` form. The percent-delimited `{{% note %}}` form, and a `title=` attribute on any of them, went unconverted -- previously an accepted gap (rare: ~3 known instances in the whole develop/clients/ rollout). data-types alone has 3 in one section (timeseries/configuration.md's bare `{{% warning %}}`, probabilistic/hyperloglogs.md's `{{% alert title="Note" color="warning" %}}`, vector-sets/_index.md's `{{< alert title="Try it out" >}}`), so it's now worth generalizing rather than hand-fixing per unit. Verified against the three real target cases (converted exactly as expected, color= silently dropped since the render hook has no color concept) plus five already-known bare-angle cases (byte-identical output, no regression). Not in scope here: content/develop/clients/redis-py and lettuce each carry 1-2 of the same unconverted percent-alert leftovers from DOC-7047 -- this fix would also resolve those, but that's a separate, already-merged section's cleanup, not this ticket's. Ticket: DOC-7055 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…nder hooks
Converts relref shortcode links to plain Markdown links and the one
percent-delimited {{% warning %}} callout (timeseries/configuration.md)
to a > [!WARNING] blockquote, via build/migrate_shortcode_links.py's
`all` stage. streams/idempotency.md, strings/bitfields.md,
strings/bitmaps.md, timeseries/configuration.md carry relref-to-plain
changes; timeseries/out-of-order_performance_considerations.md and
timeseries/use_cases.md had no relref/callout shortcodes to convert
(image shortcodes only) and are correctly untouched.
Verified with real before/after Hugo builds (using a throwaway
`git worktree add --detach` checkout for "before", since `git stash`
is unsafe here -- refs/stash is shared across all worktrees of this
repo, and sibling DOC-7055 units running in parallel worktrees raced
on it). build/diff_rendered_hrefs.py reports zero href differences
under develop/data-types/streams, /strings, and /timeseries, and the
full build's warning output is identical before/after (same 6
warnings, only absolute-path prefixes differ across the two checkouts).
Ticket: DOC-7055
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 176b5e6 |
4 tasks done
Contributor
Base automatically changed from
DOC-7055-callout-percent-form-support
to
main
September 10, 2026 14:03
4 tasks done
3 tasks done
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
2 participants
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.
Summary
content/develop/data-types/streams/,strings/, andtimeseries/(unit D of DOC-7055) fromrelref/callout Hugo shortcodes to native-Markdown render hooks, usingbuild/migrate_shortcode_links.py'sallstage.streams/_index.md,streams/idempotency.md,strings/_index.md,strings/bitfields.md,strings/bitmaps.md,timeseries/_index.md,timeseries/configuration.md. The other two (timeseries/out-of-order_performance_considerations.md,timeseries/use_cases.md) contain norelref/callout shortcodes (onlyimageshortcodes) and are correctly untouched.timeseries/configuration.mdincludes the one percent-delimited{{% warning %}}...{{% /warning %}}callout in this unit (inside a link whose anchor sits outside therelrefshortcode) — both the callout-to-blockquote conversion and the anchored link conversion were verified.Test plan
relref/callout shortcodes remain in these files, and all converted links match the established/content/<path>.md[#anchor]convention already used elsewhere in the migrated corpus (including the bare/commands/?group=...precedent for query-string-only refs).git worktree add --detachcheckout for "before" rather thangit stash, sincerefs/stashis shared across all worktrees in this repo and sibling DOC-7055 units running in parallel raced on it.build/diff_rendered_hrefs.pyreports zero href differences fordevelop/data-types/streams,develop/data-types/strings, anddevelop/data-types/timeseries(3 vs 3, 3 vs 3, 9 vs 9 pages compared).Base is
DOC-7055-callout-percent-form-support(PR #3965, not yet merged) since this stacks on its percent-delimited-callout support inmigrate_shortcode_links.py. GitHub will auto-retarget tomainonce that PR merges and its branch is deleted.Note
Low Risk
Documentation-only link and callout syntax migration with verified zero rendered href diffs; no runtime or API impact.
Overview
This PR migrates unit D of DOC-7055: develop docs for streams, strings, and timeseries from Hugo
relref(and one callout) shortcodes to native Markdown links aimed at render hooks (/content/.../*.md, including anchors and query strings like/commands/?group=timeseries).Across seven markdown files, internal references to commands and sibling pages are rewritten in bulk (the streams tutorial page alone updates a large set of
XREAD/XADD/consumer-group links).timeseries/configuration.mdalso replaces a{{% warning %}}shortcode with a> [!WARNING]blockquote while preserving the hash-tags link inside it.No tutorial prose or examples change—only link/callout syntax. Two timeseries pages with no
relref/callouts are untouched.Reviewed by Cursor Bugbot for commit 176b5e6. Bugbot is set up for automated code reviews on this repo. Configure here.