Repository navigation
DOC-7055: Migrate develop/data-types/vector-sets to render hooks - #3968
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>
Convert relref shortcodes to plain Markdown links and note/alert
shortcodes to GitHub-style blockquote alerts across all 6 pages in
content/develop/data-types/vector-sets/, using
build/migrate_shortcode_links.py's `all` stage (relref-to-plain,
callouts-to-blockquote, linkify).
Verified with a scoped before/after Hugo build: zero href differences
under develop/data-types/vector-sets (build/diff_rendered_hrefs.py),
and identical warning/error output once sorted and the one random
temp-filename suffix is normalized (matches known Hugo build
nondeterminism, not a regression).
The _index.md `{{< alert title="Try it out" >}}` right after the
vecset_tutorial clients-example widget converts to
`> [!NOTE] Try it out`, keeping the custom title. The pre-existing
bare ` ` spacer line between the widget and the alert survives
the conversion: it goes from a bare nbsp text node (old shortcode
rendering) to an nbsp wrapped in its own `<p>` tag (new blockquote
rendering) — still a real non-breaking-space gap between the two
block elements in both cases.
Ticket: DOC-7055
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 825d449 |
Contributor
This was referenced Sep 10, 2026
Base automatically changed from
DOC-7055-callout-percent-form-support
to
main
September 10, 2026 14:03
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/vector-sets/from Hugo shortcodes to native-Markdown render hooks (DOC-7055, unit C), usingbuild/migrate_shortcode_links.py all(relref-to-plain, callouts-to-blockquote, linkify)._index.md's{{< alert title="Try it out" >}}...{{< /alert >}}converts to> [!NOTE] Try it out, preserving the custom title.Verification
hugo --minify) +build/diff_rendered_hrefs.py: zero href differences fordevelop/data-types/vector-sets.readFilefailures, and a JS-minify error on/commands/cf.reserve/) reproduce identically in both before and after builds. spacer between thevecset_tutorialclients-example widget and the alert in_index.md: it still renders as a real non-breaking space between the two block elements. It now sits inside its own<p>tag (new blockquote rendering) instead of as bare text (old shortcode rendering) — a real structural difference, but one that preserves or increases the visible gap rather than collapsing it.Test plan
git diffreviewed for all 6 files — link and callout conversions look correct and match the DOC-7047 convention already used incontent/develop/clients/.python3 build/diff_rendered_hrefs.pyreports 0 href differences._index.mdalert-to-blockquote conversion inspected in rendered HTML.Base is
DOC-7055-callout-percent-form-support(PR #3965), notmain, since this stacks on that not-yet-merged script extension. GitHub will retarget tomainonce #3965 merges.Ticket: DOC-7055
Note
Low Risk
Documentation-only link and callout syntax changes with verified equivalent rendered hrefs; no product or runtime behavior changes.
Overview
Migrates all six vector sets docs under
content/develop/data-types/vector-sets/from Hugorelrefshortcodes to plain Markdown links (for example/content/commands/vsim.mdand cross-section anchors like#quantization-effects).On
_index.md, the Try it outalertshortcode becomes a> [!NOTE] Try it outblockquote callout; the Redis playground link and surrounding spacer are unchanged in source.See also sections on the sibling pages get the same link treatment.
command-group,clients-example, andimageshortcodes are untouched—this is link/callout migration only, aligned with DOC-7055 and the existing clients docs convention.Reviewed by Cursor Bugbot for commit 825d449. Bugbot is set up for automated code reviews on this repo. Configure here.