feat: Add automated image location fixing for Mintlify docs #350
+583
−8
Conversation
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
This commit introduces automation to fix image directory issues that can occur when using the Mintlify Slack app or other tools that don't follow our image directory conventions. Changes: - Add fix-image-locations.js script to automatically move images to correct directories and update all MDX references - Add GitHub Actions workflow to trigger auto-fix via bot - Enhance validation workflow to show auto-fix instructions when image issues are detected - Add comprehensive documentation in scripts/README.md Key features: - Smart handling of single-use vs shared images - Dry-run mode to preview changes safely - Automatic reference updates across all files - Can be triggered manually via GitHub Actions or run locally This addresses the issue where Mintlify Slack app doesn't respect our repo's image directory structure rules. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Instead of creating a separate scripts/README.md, integrate the auto-fix documentation into the existing validation scripts section of the main README. This keeps all contributor documentation in one place. Changes: - Add auto-fix script documentation to main README - Update troubleshooting section to reference auto-fix - Remove separate scripts/README.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
📋 Documentation Validation Report✅ All validation checks passed! 🔗 Links✅ All links valid 🖼️ Images✅ All images in correct locations |
Changes to the validation bot comment: - Remove verbose 'Quick Reference' section (not needed if we auto-fix) - Remove local script instructions (users shouldn't need to run manually) - Fix broken workflow link (was pointing to wrong URL) - Simplify to just show auto-fix button with 3 simple steps Now the comment is much cleaner and more actionable.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This commit introduces automation to fix image directory issues that can occur when using the Mintlify Slack app or other tools that don't follow our image directory conventions.
Changes:
Key features:
This addresses the issue where Mintlify Slack app doesn't respect our repo's image directory structure rules.
🤖 Generated with Claude Code