Skip to content

Fix relrefs for .md files in redisvl latest release#3079

Open
paoloredis wants to merge 1 commit intomainfrom
DOC-6504
Open

Fix relrefs for .md files in redisvl latest release#3079
paoloredis wants to merge 1 commit intomainfrom
DOC-6504

Conversation

@paoloredis
Copy link
Copy Markdown
Collaborator

@paoloredis paoloredis commented Apr 22, 2026

Note

Medium Risk
Changes the docs sync workflow’s link-rewrite rules, which could affect many generated pages if the new regexes mis-handle edge cases or anchors.

Overview
Updates the redisvl_docs_sync GitHub Actions workflow to rewrite intra-doc *.md links into Hugo relref shortcodes during the markdown formatting step, including support for stripping numeric filename prefixes (e.g. 01_) and handling both path-based and same-directory links.

This reduces broken navigation in the generated RedisVL “latest” docs by ensuring cross-page links resolve correctly after files are renamed/organized for Hugo.

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 22, 2026

DOC-6504

@jit-ci
Copy link
Copy Markdown

jit-ci Bot commented Apr 22, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

@paoloredis
Copy link
Copy Markdown
Collaborator Author

This change fixes relrefs for the concepts content, e.g. the links at the bottom of this page https://redis.io/docs/latest/develop/ai/redisvl/concepts/architecture/

@andy-stark-redis
Copy link
Copy Markdown
Contributor

@paoloredis The regexes don't seem to be quite right. For example, when I click the link to Search & Indexing at the bottom of the Architecture page, the URL is

https://redis.io/docs/staging/DOC-6504/develop/ai/redisvl/concepts/architecture/search-and-indexing.md

...which gives a 404. The actual link should be

https://redis.io/docs/staging/DOC-6504/develop/ai/redisvl/concepts/search-and-indexing

(ie, no architecture folder in the path and no .md suffix on the file name.) The staging build does seem to have completed, so I don't think it's just a stale file.

@paoloredis
Copy link
Copy Markdown
Collaborator Author

Yeah, that's expected. Right now the redisvl workflow isn't running as part of staging builds so pages won't be updated

Copy link
Copy Markdown
Contributor

@andy-stark-redis andy-stark-redis left a comment

Choose a reason for hiding this comment

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

OK, then - approved.

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.

2 participants