Skip to content

Fix docs images not rendering#143

Merged
RafaelPo merged 1 commit intomainfrom
fix/docs-images
Feb 12, 2026
Merged

Fix docs images not rendering#143
RafaelPo merged 1 commit intomainfrom
fix/docs-images

Conversation

@RafaelPo
Copy link
Contributor

Summary

  • Images in docs/images/ were stored as Git LFS pointers and not included in the Next.js static export output
  • Copied images to docs-site/public/images/ so they're bundled in the build
  • Updated markdown image paths from relative (images/...) to absolute (/docs/images/...) to match the basePath

Test plan

  • Verify both images render on the docs site after deploy
  • Check /docs/active-learning-llm-oracle shows the learning curve chart
  • Check /docs/scale-deduplication-20k-rows shows the scaling chart

🤖 Generated with Claude Code

Images in docs/images/ weren't included in the Next.js static export.
Copied them to docs-site/public/images/ so they're included in the
build output, and updated markdown to use absolute paths with the
/docs basePath.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@RafaelPo RafaelPo merged commit 0b8bcd7 into main Feb 12, 2026
3 checks passed
@RafaelPo RafaelPo deleted the fix/docs-images branch February 12, 2026 15:11
Comment on lines +1 to +3
version https://git-lfs.github.com/spec/v1
oid sha256:b2b4b0dc668c3051ed25e7cec0f956fb0d376a059e0620987ac17468c1271fcc
size 326137
Copy link

Choose a reason for hiding this comment

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

Bug: Images will be broken in production. The build process doesn't download the Git LFS files, and the markdown references incorrect image paths for the Next.js basePath configuration.
Severity: CRITICAL

Suggested Fix

To resolve the Git LFS issue, add lfs: true to the actions/checkout@v4 step in the .github/workflows/deploy-docs.yaml workflow. To fix the pathing, either move the images from docs-site/public/images/ to a new docs-site/public/docs/images/ directory, or update the markdown image references to be root-relative (e.g., /images/learning_curve_accuracy.png) instead of being prefixed with /docs.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: docs-site/public/images/fda_10pct_scaling.png#L1-L3

Potential issue: The deployment workflow does not correctly handle Git LFS-tracked
images. The `actions/checkout@v4` step lacks configuration to pull LFS objects, causing
it to check out small text pointer files instead of the actual image data. Additionally,
the image paths referenced in the markdown files, such as
`/docs/images/learning_curve_accuracy.png`, are incorrect. Due to the Next.js `basePath:
"/docs"` configuration, the server will attempt to find these images at
`public/docs/images/`, but they are located at `public/images/`. This combination of
issues will result in broken images on the deployed documentation site, as browsers will
receive either a 404 error or a text pointer file instead of a renderable image.

Did we get this right? 👍 / 👎 to inform future reviews.

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