-
-
Notifications
You must be signed in to change notification settings - Fork 638
Fix broken image issue #1757
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix broken image issue #1757
Conversation
WalkthroughReplaces a documentation image URL in docs/react-on-rails-pro/major-performance-breakthroughs-upgrade-guide.md from an external GitHub attachment to a local relative asset path. No other content or code changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
docs/assets/early-hydration-performance-comparison.jpgis excluded by!**/*.jpg
📒 Files selected for processing (1)
docs/react-on-rails-pro/major-performance-breakthroughs-upgrade-guide.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: alexeyr-ci2
PR: shakacode/react_on_rails#1732
File: spec/dummy/client/app-react16/startup/ReduxSharedStoreApp.client.jsx:40-44
Timestamp: 2025-04-26T21:55:55.874Z
Learning: In the react_on_rails project, files under `app-react16` directories are copied/moved to corresponding `/app` directories during the conversion process (removing the `-react16` suffix), which affects their relative import paths at runtime.
📚 Learning: 2025-04-26T21:55:55.874Z
Learnt from: alexeyr-ci2
PR: shakacode/react_on_rails#1732
File: spec/dummy/client/app-react16/startup/ReduxSharedStoreApp.client.jsx:40-44
Timestamp: 2025-04-26T21:55:55.874Z
Learning: In the react_on_rails project, files under `app-react16` directories are copied/moved to corresponding `/app` directories during the conversion process (removing the `-react16` suffix), which affects their relative import paths at runtime.
Applied to files:
docs/react-on-rails-pro/major-performance-breakthroughs-upgrade-guide.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: dummy-app-integration-tests (oldest)
- GitHub Check: dummy-app-integration-tests (newest)
- GitHub Check: rspec-package-tests (oldest)
- GitHub Check: rspec-package-tests (newest)
- GitHub Check: build
| _Performance improvement visualization:_ | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Local image path may still 404 unless the asset is added and the docs pipeline serves docs/assets.
- Confirm the image file is committed at docs/assets/early-hydration-performance-comparison.jpg.
- Ensure your docs tool (GitHub rendering, Jekyll, Docusaurus, etc.) serves assets from docs/assets via relative paths. Docusaurus typically expects files under website/static/img and links like /img/...; Jekyll often uses /assets or a baseurl prefix.
If you’re using Docusaurus, consider moving the image to static/img and updating the path:
-
+Optionally, use a compressed .webp to reduce repo weight:
-
+Run to verify existence and detect docs tooling:
🏁 Script executed:
#!/bin/bash
# 1) Verify the asset exists (case-sensitive)
fd -tf -p '^early-hydration-performance-comparison\.(jpg|jpeg|png|webp)$' docs
# 2) Show likely docs tooling
fd -tf -HI 'docusaurus.config.*|mkdocs.y*ml|_config.yml|package.json' | sed 's/^/tooling: /'
# 3) Grep for other image references to align conventions
rg -n '!\[.*\]\((\.\./)?assets/.*\)' docs -C1Length of output: 1208
Add missing image asset and verify serving
- Add
docs/assets/early-hydration-performance-comparison.jpg(or an optimized.webp) so the Markdown link resolves. - Ensure your docs build pipeline serves files from
docs/assetsvia the../assets/...path. If you’re on Docusaurus, move the image tostatic/imgand update the link to/img/early-hydration-performance-comparison.jpg.
🤖 Prompt for AI Agents
In docs/react-on-rails-pro/major-performance-breakthroughs-upgrade-guide.md
around line 74 the referenced image
../assets/early-hydration-performance-comparison.jpg is missing causing a broken
link; add the image file (preferably optimized .webp) at
docs/assets/early-hydration-performance-comparison.jpg or, if the site uses
Docusaurus, move the image to static/img and update the Markdown link to
/img/early-hydration-performance-comparison.jpg; then verify the docs build
pipeline serves that directory (or update static asset config) and rebuild to
confirm the image resolves.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
…pgrade guide
Summary
Remove this paragraph and provide a general description of the code changes in your pull
request... were there any bugs you had fixed? If so, mention them. If
these bugs have open GitHub issues, be sure to tag them here as well,
to keep the conversation linked together.
Pull Request checklist
Remove this line after checking all the items here. If the item is not applicable to the PR, both check it out and wrap it by
~.Add the CHANGELOG entry at the top of the file.
Other Information
Remove this paragraph and mention any other important and relevant information such as benchmarks.
This change is
Summary by CodeRabbit