Skip to content

Conversation

@saseungmin
Copy link
Member

@saseungmin saseungmin commented Jul 8, 2025

Summary by CodeRabbit

  • Documentation
    • Updated README files to replace relative links and image sources with absolute URLs for improved accessibility.
    • Fixed broken links in documentation, ensuring all assets and guides are correctly referenced.
  • Chores
    • Added a changeset entry to document the patch update for the package.

@changeset-bot
Copy link

changeset-bot bot commented Jul 8, 2025

🦋 Changeset detected

Latest commit: c249151

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
react-native-youtube-bridge Patch
example Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai
Copy link

coderabbitai bot commented Jul 8, 2025

Walkthrough

This update replaces relative links and image sources in the English and Korean README files of the react-native-youtube-bridge package with absolute URLs pointing to the official GitHub repository. A new changeset documents the patch, which addresses broken links in the documentation without modifying any code or exported entities.

Changes

File(s) Change Summary
packages/react-native-youtube-bridge/README.md
packages/react-native-youtube-bridge/README-ko_kr.md
Updated image sources and documentation links from relative paths to absolute GitHub URLs
.changeset/public-pets-go.md Added changeset documenting the patch for fixing broken README links

Possibly related PRs

  • #39: Adjusts relative image paths in README files, similar to this PR's focus on link corrections.
  • #6: Adds initial Korean and English README documentation, related through documentation updates.

Poem

🐇
I hopped through docs, both near and far,
Fixing links to where the assets are.
Now images load and guides are clear,
With URLs that point right here.
README shines, no links astray—
A rabbit’s work, tidy and gay!


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.
    • Explain this complex logic.
    • 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. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • 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 src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai 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

Documentation and Community

  • 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

@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: 0

🧹 Nitpick comments (3)
.changeset/public-pets-go.md (1)

5-5: Terminate the summary sentence with a period.

A period is missing at the end of the description line; this trips markdown-lint and keeps style inconsistent with other changeset files.

-fix: resolve broken links in README files
+fix: resolve broken links in README files.
packages/react-native-youtube-bridge/README.md (1)

26-28: Add alt text for accessibility & markdown-lint (MD045) compliance.

The newly-added absolute image link still lacks alternative text, which hurts accessibility tooling and triggers MD045. A short, descriptive alt text is enough:

-  <img src="https://raw.githubusercontent.com/react-native-bridges/react-native-youtube-bridge/main/assets/example.gif" width="600" />
+  <img alt="YouTube player example demo" src="https://raw.githubusercontent.com/react-native-bridges/react-native-youtube-bridge/main/assets/example.gif" width="600" />
packages/react-native-youtube-bridge/README-ko_kr.md (1)

26-28: alt 속성을 추가해 접근성과 MD045 경고를 함께 해결하세요.

GIF 이미지를 절대 경로로 교체한 것은 👍입니다만, alt 텍스트가 없어 접근성·lint 모두에서 경고가 발생합니다.

-  <img src="https://raw.githubusercontent.com/react-native-bridges/react-native-youtube-bridge/main/assets/example.gif" width="600" />
+  <img alt="YouTube player 예제 데모" src="https://raw.githubusercontent.com/react-native-bridges/react-native-youtube-bridge/main/assets/example.gif" width="600" />
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4eec4d0 and c249151.

📒 Files selected for processing (3)
  • .changeset/public-pets-go.md (1 hunks)
  • packages/react-native-youtube-bridge/README-ko_kr.md (3 hunks)
  • packages/react-native-youtube-bridge/README.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/react-native-youtube-bridge/README.md

[grammar] ~244-~244: Use proper spacing conventions.
Context: ...-youtube-bridge/tree/main/packages/web). > [!NOTE] > webViewUrl Usage > - When ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~283-~283: Use proper spacing conventions.
Context: ...-youtube-bridge/tree/main/packages/web). ### YouTube oEmbed API Use the `useYoutubeOE...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)

packages/react-native-youtube-bridge/README-ko_kr.md

[grammar] ~244-~244: Use proper spacing conventions.
Context: ...bridge/tree/main/packages/web)를 참고해 주세요. > [!NOTE] > webViewUrl 활용법 > - `useInl...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~283-~283: Use proper spacing conventions.
Context: ...bridge/tree/main/packages/web)를 참고해 주세요. ### YouTube oEmbed API useYoutubeOEmbed 훅을...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)

.changeset/public-pets-go.md

[grammar] ~5-~5: Place a period at the end of declarative sentences.
Context: ...ix: resolve broken links in README files

(QB_NEW_EN_OTHER_ERROR_IDS_000178)

🪛 markdownlint-cli2 (0.17.2)
packages/react-native-youtube-bridge/README-ko_kr.md

27-27: Images should have alternate text (alt text)

(MD045, no-alt-text)

@saseungmin saseungmin merged commit ba12f3d into main Jul 8, 2025
5 checks passed
@saseungmin saseungmin deleted the fix/broken-readme-links branch July 8, 2025 09:58
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.

2 participants