Skip to content

fix: remove Git LFS tracking for docs images - #446

Merged
Nikhil (shadowfax92) merged 1 commit into
mainfrom
fix/docs-images-lfs
Mar 15, 2026
Merged

fix: remove Git LFS tracking for docs images#446
Nikhil (shadowfax92) merged 1 commit into
mainfrom
fix/docs-images-lfs

Conversation

@shadowfax92

Copy link
Copy Markdown
Contributor

Summary

  • Root cause: .gitattributes had docs/images/** filter=lfs which stored all doc images as ~130-byte LFS pointer files
  • Why it broke: Mintlify clones the repo but doesn't run git lfs pull, so it served the raw pointer files instead of actual images — breaking every image on docs.browseros.com
  • Why some images worked: Images outside docs/images/ (e.g. features/workflow/, features/cowork/) were never LFS-tracked, so Mintlify got the real files
  • Fix: Remove the LFS tracking rule and re-add images as regular git blobs. No file moves, no path changes, no MDX edits needed
  • Also fixes the Slack link placeholder in the troubleshooting page

Test plan

  • Verify all images render on docs.browseros.com after deploy
  • Spot-check: homepage hero, BYOLLM screenshots, changelog images, troubleshooting page

🤖 Generated with Claude Code

Mintlify deploys docs by cloning the repo but does not run `git lfs
pull`. The `.gitattributes` rule `docs/images/** filter=lfs` caused
all doc images to be stored as ~130-byte LFS pointer files, which
Mintlify served as-is — breaking every image on the site.

Removing the LFS rule and re-adding the files as regular git blobs
fixes all images without changing any paths or MDX files.

Also fixes broken Slack link placeholder in troubleshooting page.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@greptile-apps

greptile-apps Bot commented Mar 15, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Removes Git LFS tracking for docs/images/** and re-commits all 85 doc images as regular git blobs. This fixes broken image rendering on docs.browseros.com — Mintlify clones the repo without running git lfs pull, so it was serving raw 130-byte LFS pointer files instead of actual images. Also replaces a SLACK_LINK_HERE placeholder in the troubleshooting page with the real Slack invite link.

  • Removed docs/images/** filter=lfs diff=lfs merge=lfs -text rule from .gitattributes
  • Converted 85 images from LFS pointers (~130 bytes each) to actual binary blobs
  • Fixed Slack link placeholder in docs/troubleshooting/connection-issues.mdx
  • LFS tracking for docs/videos/** and other media files remains intact

Confidence Score: 5/5

  • This PR is safe to merge — it fixes broken doc images with no risk to application code.
  • The changes are limited to a single .gitattributes rule removal, binary image file conversions (LFS pointers to real blobs), and a one-line Slack link fix. No application code is modified. The root cause analysis is sound — Mintlify doesn't run git lfs pull, so LFS-tracked images were broken. The fix is correct and complete.
  • No files require special attention.

Important Files Changed

Filename Overview
.gitattributes Removes the docs/images/** LFS tracking rule while keeping LFS for docs/videos/** and other media. Clean, targeted fix.
docs/troubleshooting/connection-issues.mdx Replaces SLACK_LINK_HERE placeholder with the actual Slack invite link (https://dub.sh/browserOS-slack). No other placeholders remain.
docs/images/hero-dark.png Converted from 132-byte LFS pointer to 2.6 MB actual image blob. Representative of all 85 image conversions in this PR.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Git Push to Main] --> B[Mintlify clones repo]
    B --> C{Image in LFS?}
    C -->|Yes - Before fix| D[Serves 130-byte LFS pointer]
    D --> E[Broken image on docs site]
    C -->|No - After fix| F[Serves actual image blob]
    F --> G[Image renders correctly]
Loading

Last reviewed commit: 00a6b78

@shadowfax92
Nikhil (shadowfax92) merged commit ecd31ef into main Mar 15, 2026
3 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Mar 15, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant