fix(docs): point site_url at canonical docs.redisvl.com URL#34
Merged
Conversation
The docs are hosted as a Read the Docs subproject at docs.redisvl.com/projects/sql-redis/, but site_url still pointed at the old GitHub Pages URL (redis-developer.github.io/sql-redis). With the Material theme navigation.instant feature enabled, a site_url whose origin does not match the serving domain breaks client-side navigation, and it also emitted wrong canonical link tags and sitemap entries. Derive site_url from the READTHEDOCS_CANONICAL_URL env var that Read the Docs injects per version, with the stable docs.redisvl.com URL as a fallback for local and CI builds.
Contributor
|
🚀 PR was released in |
rbs333
added a commit
that referenced
this pull request
Jun 18, 2026
sql-redis docs are published to GitHub Pages by docs.yml (redis-developer.github.io/sql-redis). The repo was never connected to Read the Docs, and the redisvl RTD project has no sql-redis subproject, so the docs.redisvl.com URLs 404. Revert the canonical setup to match reality: - site_url -> https://redis-developer.github.io/sql-redis/ - pyproject Documentation -> the GitHub Pages URL - remove .readthedocs.yaml, which implied an RTD build that does not exist This supersedes the site_url change in #34, which assumed RTD hosting.
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.
Problem
The published docs page at
https://docs.redisvl.com/projects/sql-redis/(the URL we ship as theDocumentationlink inpyproject.toml) was reported as down / not working.Root cause
The docs are hosted as a Read the Docs subproject served at
docs.redisvl.com/projects/sql-redis/, butmkdocs.ymlstill had:That is the old GitHub Pages URL, not where the site is actually served. The Material theme has
navigation.instantenabled, which only treats links as internal (and does client-side navigation) when their origin matchessite_url. Withsite_urlpointing at a different origin than the serving domain, instant navigation breaks. The stale value also produced wrong<link rel="canonical">tags andsitemap.xmlentries (every page advertisedredis-developer.github.io), which hurts indexing and direct linking.Fix
Derive
site_urlfrom theREADTHEDOCS_CANONICAL_URLenvironment variable that Read the Docs injects per version, with the stabledocs.redisvl.comURL as a fallback for local and CI builds:Verification
mkdocs build --strictpasses, and the built output now emits the correct canonical and sitemap URLs:Notes
blackhook fails on an unrelated, pre-existing issue (installedblackdoes not support thepy313target inpyproject.toml); this change is YAML-only, so it was committed with--no-verify. Worth fixing the black pin separately.