Repository navigation
DOC-7128: make the RedisVL sync emit Markdown images, and convert its 19 copies - #4206
Merged
Merged
Conversation
… 19 copies build/redisvl_docs_sync.py turned upstream `` images into the image shortcode, so converting the synced files by hand would have been undone by the next sync. It now emits ``, and the 19 copies of the architecture diagram (one per RedisVL version) are converted to match. The script's new output is byte-identical to the converted lines, so the next sync regenerates them with no churn. With this, no content file uses the image shortcode, and none render anywhere on the site. Verified under the production baseURL: all 19 diagrams render with an identical src/width/alt/class at /docs/latest/images/redisvl/..., and the AI Markdown feed keeps its 19 absolute image URLs. Constraint: redisvl_docs_sync.py must emit Markdown images; reverting it to the shortcode would bring back a shortcode the site no longer defines once it's retired Ticket: DOC-7128 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 28d5ca1 |
paoloredis
approved these changes
Oct 5, 2026
Contributor
Author
|
Thanks @paoloredis ! |
andy-stark-redis
added a commit
that referenced
this pull request
Oct 5, 2026
Every image on the site is now Markdown, rendered by layouts/_default/_markup/render-image.html: 1,829 shortcodes converted across #4151 to #4206. No content file calls {{< image >}}, so the shortcode is deleted, along with the two process-markdown-content.html rules that rewrote it for the AI Markdown/JSON feed (the Markdown-image rules stay). It also deletes five embeds that nothing includes and that never rendered, because content/embeds/ is build: render: never: account-role-table.html, create-db.md, rc-create-db-use-cases.md, rc-version-upgrade.md, and tls-configuration-procedure.md. README.md's Images section now shows the Markdown forms (plain, with an attribute line, and inline icon), and HUGO_DEPENDENCY_ASSESSMENT.md's link to the deleted template points at render-image.html. A throwaway site confirmed that Hugo fails the build on a call to a missing shortcode (exit 1), so clean builds under the production baseURL, both normal and with drafts, show that nothing still calls it. Against main: 0 image differences, and the AI feed files are identical apart from Git dates that come from the baseline build. Learned: Hugo fails the build on a call to a missing shortcode, but --quiet plus a pipe hides both the error and the exit code; check $? directly Constraint: write images as Markdown; the image shortcode no longer exists, and any {{< image >}} call fails the build Ticket: DOC-7128 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Oct 5, 2026
Makes the RedisVL sync emit Markdown images and converts its 19 architecture-diagram copies. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
The last image shortcodes on the site were the RedisVL architecture diagram, one copy per RedisVL version. They couldn't be hand-converted like the rest, because
build/redisvl_docs_sync.pywrites the shortcode itself. Upstream images arrive as, and line 652 turned them into{{< image … >}}, so the next sync would have undone any hand edit. Part of DOC-7128..With this PR, no content file uses the
imageshortcode, and none render anywhere on the site. The shortcode template itself can be retired in a follow-up.Verification
mainand this branch under the production baseURL (/docs/latest/): both succeeded (19,673 pages), and the hook reported no missing images.src/width/alt/class. 0 image differences on any page.sdata-lightboxshortcode wrappers left in the rendered site: 19 onmain, 0 on this branch.🤖 Generated with Claude Code
Note
Low Risk
Docs-only markup change in the RedisVL sync pipeline and mirrored architecture pages; no runtime or security impact.
Overview
Switches RedisVL doc sync and synced content from Hugo
{{< image >}}shortcodes to standard Markdown images for the architecture diagram.build/redisvl_docs_sync.pynow maps upstreamtoinstead of emitting theimageshortcode, so future syncs won’t reintroduce shortcodes. The 19concepts/architecture.mdcopies (latest + versioned paths) are updated to the same Markdown line, removing the last in-repo uses of theimageshortcode (DOC-7128).Reviewed by Cursor Bugbot for commit 28d5ca1. Bugbot is set up for automated code reviews on this repo. Configure here.