fix: copy media files before FORD to fix GitHub Pages image paths - Issue #205 #206
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
…sue #205 Add comprehensive tests demonstrating current broken behavior where media files are copied AFTER FORD processes markdown files, causing broken image links in GitHub Pages documentation. Tests include: - Media file staging validation (fails until fix implemented) - Relative path resolution from generated HTML directories - Documentation build process integration testing - Image accessibility validation for GitHub Pages structure - Shell validation script for CI/CD pipeline Given-When-Then documentation provided for each test scenario. Tests demonstrate the issue and will pass once the media staging timing is fixed. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
- Move media file copying BEFORE ford command in Makefile doc target - Move media file copying BEFORE make doc in GitHub Actions workflow - Fix validation script logic to correctly verify media staging order - Ensures FORD processes markdown with media files already in place - Fixes broken image paths in deployed GitHub Pages documentation This resolves issue #205 where images were broken because media files were copied after FORD had already processed the markdown files with relative paths that couldn't resolve. Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
krystophny
changed the title
- FORD clears build/doc when it starts, so media must be copied AFTER - Revert to the working configuration from commit fad78d5 - Media files are now copied after FORD completes documentation generation - This ensures relative paths ../../media/examples/ resolve correctly in GitHub Pages
…correctly Critical fix to doc target that ensures media files are in place at build/doc/media/examples/ BEFORE FORD processes the documentation. This allows FORD to correctly resolve image paths during documentation generation.
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.
Summary
Fix broken PNG image paths in GitHub Pages documentation by ensuring media files are copied BEFORE FORD processes markdown files.
Changes
Makefile (
doctarget):ford README.mdcommandGitHub Actions workflow (
.github/workflows/docs.yml):make doccommandValidation script (
scripts/validate_github_pages_images.sh):Test Results
All tests now PASS:
Impact
This fix ensures that:
Fixes #205
Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com