Skip to content

update for redisvl 0.18.0#3097

Closed
github-actions[bot] wants to merge 1 commit intomainfrom
redisvl_docs_sync_0.18.0
Closed

update for redisvl 0.18.0#3097
github-actions[bot] wants to merge 1 commit intomainfrom
redisvl_docs_sync_0.18.0

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented Apr 24, 2026

update for redisvl 0.18.0


Note

Low Risk
Low risk documentation-only changes; main risk is broken navigation if any relref targets or renamed user guide slugs don’t exist at build time.

Overview
Updates RedisVL concept/user-guide docs to use Hugo shortcodes: replaces the architecture diagram markdown image with {{< image >}} and adds the diagram SVG under static/images/redisvl.

Converts many relative markdown links (concepts, API refs, and user guide pages) to {{< relref >}} and switches user-guide references from numbered filenames (e.g. 01_getting_started.md) to slug-based paths (e.g. getting_started).

Reviewed by Cursor Bugbot for commit 67e8114. Bugbot is set up for automated code reviews on this repo. Configure here.

@jit-ci
Copy link
Copy Markdown

jit-ci Bot commented Apr 24, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 67e8114. Configure here.

- you want to reuse an existing Redis index without rebuilding retrieval logic in every client

For setup steps, config, commands, and examples, see [Run RedisVL MCP](../user_guide/how_to_guides/mcp.md).
For setup steps, config, commands, and examples, see [Run RedisVL MCP]({{< relref "../user_guide/how_to_guides/mcp" >}}).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Broken relref link to nonexistent MCP page

High Severity

The relref to "../user_guide/how_to_guides/mcp" points to a page that doesn't exist — the how_to_guides directory has no mcp.md file (or any content files at all). Converting the old plain markdown link to a Hugo relref shortcode means this will now cause a Hugo build failure, rather than just producing a 404 at runtime.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 67e8114. Configure here.

@paoloredis paoloredis closed this Apr 27, 2026
@paoloredis paoloredis deleted the redisvl_docs_sync_0.18.0 branch April 27, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant