Skip to content

Update README demo image link and include additional context; add images directory to .vscodeignore#155

Open
ryo8000 wants to merge 1 commit into
mainfrom
readme
Open

Update README demo image link and include additional context; add images directory to .vscodeignore#155
ryo8000 wants to merge 1 commit into
mainfrom
readme

Conversation

@ryo8000

@ryo8000 ryo8000 commented May 17, 2026

Copy link
Copy Markdown
Owner

No description provided.

@coderabbitai

coderabbitai Bot commented May 17, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@ryo8000 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 33 minutes and 51 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7bd0ac0e-c424-4c72-95af-d706712039ad

📥 Commits

Reviewing files that changed from the base of the PR and between 55cab34 and deabb0b.

📒 Files selected for processing (2)
  • .vscodeignore
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch readme

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the demo image in the README to use an absolute GitHub URL and adds the images directory to the .vscodeignore file. Feedback suggests reverting the image path to a relative one and including the images directory in the extension package to ensure offline availability and better resilience across repository changes.

Comment thread README.md
## Demo

![XYJson demo](images/demo.gif)
![XYJson demo showing conversion between XML, YAML, and JSON in VS Code](https://raw.githubusercontent.com/ryo8000/xyjson/main/images/demo.gif)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Using a hardcoded absolute URL for the demo image is generally discouraged for VS Code extensions.

  • Resilience: If the repository is renamed, moved, or the default branch changes, this link will break. Both GitHub and the VS Code Marketplace automatically resolve relative paths using the repository metadata.
  • Offline Support: Using a relative path allows the image to be bundled within the .vsix package, ensuring the documentation remains fully functional in the VS Code extension details view even without an internet connection.
  • Branch Consistency: Absolute URLs pointing to main won't reflect updates to the image in feature branches or pull requests.

Unless the image is exceptionally large and you specifically want to exclude it from the bundle to minimize package size, a relative path is preferred.

Suggested change
![XYJson demo showing conversion between XML, YAML, and JSON in VS Code](https://raw.githubusercontent.com/ryo8000/xyjson/main/images/demo.gif)
![XYJson demo showing conversion between XML, YAML, and JSON in VS Code](images/demo.gif)

Comment thread .vscodeignore
.vscode/**
.vscode-test/**
out/test/**
images/**

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Excluding the images directory from the extension package prevents assets from being available offline in the VS Code extension manager. If the demo image is reverted to a relative path in the README.md (as suggested), this line should be removed to ensure the image is bundled. If the goal was to reduce the .vsix file size, consider optimizing the GIF (e.g., using a tool like gifsicle) instead of hosting it externally.

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.

1 participant