fix(docs): point docs at GitHub Pages, the actual host#36
Merged
Conversation
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.
Contributor
|
🚀 PR was released in |
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
1 participant
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
Corrects the docs hosting config to match where sql-redis docs are actually served: GitHub Pages (
redis-developer.github.io/sql-redis/), published by.github/workflows/docs.yml.Why
Investigating the reported
docs.redisvl.com/.../sql-redis404 turned up the real cause: the repo was never connected to Read the Docs. The RTD API confirms there is nosql-redisRTD project, and theredisvlRTD project has zero subprojects. Thedocs.redisvl.comURLs never existed. Meanwhiledocs.ymlhas been quietly deploying the site to GitHub Pages all along (returns 200).This means #34 (which pointed
site_urlatdocs.redisvl.com) was based on a wrong assumption and actually made the live GitHub Pages site advertise a canonical URL that 404s. This PR supersedes that.Changes
site_url->https://redis-developer.github.io/sql-redis/pyprojectDocumentation-> the GitHub Pages URL.readthedocs.yaml(implied an RTD build that does not exist)Verification
mkdocs build --strictpasses; built canonical + sitemap now point atredis-developer.github.io/sql-redis/.Note
This keeps sql-redis on GitHub Pages for now (team decision). It diverges from the RTD/docs.redisvl.com standard in the new Applied AI Repository Standards page; we can migrate to an RTD subproject later when the redisvl RTD account is wired up. YAML/TOML-only change, committed with
--no-verify(unrelated pre-existing black hook issue).