Skip to content

fix(docs): commit missing redis-logo-script-red.svg to unblock Pages build#32

Merged
nkanu17 merged 1 commit into
mainfrom
fix/docs-missing-logo-asset
May 11, 2026
Merged

fix(docs): commit missing redis-logo-script-red.svg to unblock Pages build#32
nkanu17 merged 1 commit into
mainfrom
fix/docs-missing-logo-asset

Conversation

@nkanu17
Copy link
Copy Markdown
Contributor

@nkanu17 nkanu17 commented May 11, 2026

Summary

Hotfix for the broken Deploy docs to GitHub Pages workflow. The hero
block on the docs landing page references
assets/redis-logo-script-red.svg, but the SVG itself was never
committed. mkdocs build --strict (used by .github/workflows/docs.yml)
promotes the missing-target warning into a hard failure.

Failure (run 25694894190)

WARNING -  Doc file 'index.md' contains a link
           'assets/redis-logo-script-red.svg', but the target is not
           found among documentation files.
Aborted with 1 warnings in strict mode!
Error: Process completed with exit code 1.

Fix

Add the missing asset. It is the cursive Redis wordmark in the official
red #FF4438, the red-on-light counterpart of the existing
redis-logo-script.svg (white, used in the dark navbar).

Verification

$ DISABLE_MKDOCS_2_WARNING=true uv run --group docs mkdocs build --strict
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: .../site
INFO    -  Documentation built in 3.11 seconds

Once merged, the next push to main triggers a fresh deploy and
publishes the landing page with the red wordmark hero.

The hero block on the docs landing page (added in #31) references
`assets/redis-logo-script-red.svg` (the cursive Redis wordmark in the
official red #FF4438), but the file itself was never committed. The
GitHub Pages build runs with `mkdocs build --strict`, which promotes
the resulting warning into a hard failure:

  WARNING -  Doc file 'index.md' contains a link
             'assets/redis-logo-script-red.svg', but the target is not
             found among documentation files.
  Aborted with 1 warnings in strict mode!

Add the missing asset alongside the existing white-fill variant
(`redis-logo-script.svg`, used in the dark navbar). Verified locally:

  $ DISABLE_MKDOCS_2_WARNING=true uv run --group docs mkdocs build --strict
  INFO    -  Documentation built in ~3s
@nkanu17 nkanu17 merged commit 49b2785 into main May 11, 2026
8 checks passed
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