Skip to content

Conversation

@AbanoubGhadban
Copy link
Collaborator

@AbanoubGhadban AbanoubGhadban commented Sep 2, 2025

…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/update test to cover these changes
  • Update documentation
  • Update CHANGELOG file

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 Reviewable

Summary by CodeRabbit

  • Documentation
    • Updated the performance guide to use a locally bundled image instead of an external link.
    • Improves reliability of image loading, faster rendering, and better offline/air-gapped access.
    • No content changes to the guide text.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 2, 2025

Walkthrough

Replaces 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

Cohort / File(s) Summary of Changes
Docs asset path update
docs/react-on-rails-pro/major-performance-breakthroughs-upgrade-guide.md
Switched performance visualization image source from external URL to ../assets/early-hydration-performance-comparison.jpg.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • justin808
  • Romex91
  • alexeyr-ci2

Poem

A hop and a swap of an image path trail,
From clouds to our burrow, no chance it’ll fail.
Thump-thump—docs tidy, assets aligned,
Carrot-cached pixels, crisply defined.
Bunny approved: local and fine. 🥕✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch abanoubghadban/fix-broken-image-at-docs

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 940108e and 5173b99.

⛔ Files ignored due to path filters (1)
  • docs/assets/early-hydration-performance-comparison.jpg is 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:_

![Performance comparison showing early hydration improvement](https://github.com/user-attachments/assets/ae33fe14-42f1-4cc1-bde3-9c5bb570cdbf)
![Performance comparison showing early hydration improvement](../assets/early-hydration-performance-comparison.jpg)
Copy link
Contributor

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:

-![Performance comparison showing early hydration improvement](../assets/early-hydration-performance-comparison.jpg)
+![Performance comparison showing early hydration improvement](/img/early-hydration-performance-comparison.jpg)

Optionally, use a compressed .webp to reduce repo weight:

-![Performance comparison showing early hydration improvement](../assets/early-hydration-performance-comparison.jpg)
+![Performance comparison showing early hydration improvement](../assets/early-hydration-performance-comparison.webp)

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 -C1

Length 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/assets via the ../assets/... path. If you’re on Docusaurus, move the image to static/img and 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.

Copy link
Contributor

@rameziophobia rameziophobia left a comment

Choose a reason for hiding this comment

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

LGTM

@justin808 justin808 merged commit 301e9c8 into master Sep 2, 2025
11 checks passed
@justin808 justin808 deleted the abanoubghadban/fix-broken-image-at-docs branch September 2, 2025 21:19
justin808 pushed a commit that referenced this pull request Sep 4, 2025
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.

3 participants