docs: update Custom Player Page root readme & remove changelog #49
Conversation
|
WalkthroughThis update deletes the Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant CustomPlayerPage (React)
participant YoutubePlayer (web package)
Developer->>CustomPlayerPage: Create functional component
CustomPlayerPage->>YoutubePlayer: Import and render YoutubePlayer
YoutubePlayer->>YouTube IFrame API: Initialize and play video
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
saseungmin
changed the title
Deploying react-native-youtube-bridge-example with
|
| Latest commit: |
196288f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f07de8b4.react-native-youtube-bridge-example.pages.dev |
| Branch Preview URL: | https://docs-update-root-readme.react-native-youtube-bridge-example.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
CHANGELOG.md(0 hunks)README-ko_kr.md(1 hunks)README.md(1 hunks)
💤 Files with no reviewable changes (1)
- CHANGELOG.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
267-267: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
README-ko_kr.md
267-267: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
| **Custom Player Page** | ||
|
|
||
| To use your own custom player page, you can build a React-based player using `@react-native-youtube-bridge/web`. | ||
|
|
||
| ```tsx | ||
| import { YoutubePlayer } from '@react-native-youtube-bridge/web'; | ||
|
|
||
| function CustomPlayerPage() { | ||
| return <YoutubePlayer />; | ||
| } | ||
|
|
||
| export default CustomPlayerPage; | ||
| ``` | ||
|
|
||
| > For more details, please refer to the [Web Player Guide](./packages/web/). |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Convert bolded text to a proper Markdown heading to satisfy MD036 and keep the TOC consistent.
markdownlint flags the current emphasis (**Custom Player Page**) because it’s being used as a heading.
Every other subsection (e.g. “### Events”, “### Functions”) already uses ###-style headings, so keeping the same convention avoids breaking automatic TOC generators and keeps the style uniform.
-**Custom Player Page**
+### Custom Player Page📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Custom Player Page** | |
| To use your own custom player page, you can build a React-based player using `@react-native-youtube-bridge/web`. | |
| ```tsx | |
| import { YoutubePlayer } from '@react-native-youtube-bridge/web'; | |
| function CustomPlayerPage() { | |
| return <YoutubePlayer />; | |
| } | |
| export default CustomPlayerPage; | |
| ``` | |
| > For more details, please refer to the [Web Player Guide](./packages/web/). | |
| ### Custom Player Page | |
| To use your own custom player page, you can build a React-based player using `@react-native-youtube-bridge/web`. | |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
267-267: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In README.md around lines 267 to 281, the text "Custom Player Page" is currently
bolded but should be converted to a proper Markdown heading to comply with
markdownlint rule MD036 and maintain TOC consistency. Replace the bolded text
with a heading using the same style as other subsections, such as prefixing it
with "###" to make it a level 3 heading.
| **커스텀 플레이어 페이지** | ||
|
|
||
| 직접 제작한 커스텀 플레이어 페이지를 사용하려면, `@react-native-youtube-bridge/web`을 활용하여 React 기반의 플레이어 페이지를 구축할 수 있습니다. | ||
|
|
||
| ```tsx | ||
| import { YoutubePlayer } from '@react-native-youtube-bridge/web'; | ||
|
|
||
| function CustomPlayerPage() { | ||
| return <YoutubePlayer />; | ||
| } | ||
|
|
||
| export default CustomPlayerPage; | ||
| ``` | ||
|
|
||
| > 자세한 내용은 [웹 플레이어 가이드](./packages/web/)를 참고해 주세요. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
헤딩 형식 통일 및 MD036 해결 – 굵게 처리된 텍스트를 헤딩으로 전환하세요.
영문 README와 동일하게 **커스텀 플레이어 페이지** 대신 ### 헤딩을 사용하면
(1) lint 오류(MD036)를 제거하고, (2) 자동 목차·스타일 일관성을 유지할 수 있습니다.
-**커스텀 플레이어 페이지**
+### 커스텀 플레이어 페이지📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **커스텀 플레이어 페이지** | |
| 직접 제작한 커스텀 플레이어 페이지를 사용하려면, `@react-native-youtube-bridge/web`을 활용하여 React 기반의 플레이어 페이지를 구축할 수 있습니다. | |
| ```tsx | |
| import { YoutubePlayer } from '@react-native-youtube-bridge/web'; | |
| function CustomPlayerPage() { | |
| return <YoutubePlayer />; | |
| } | |
| export default CustomPlayerPage; | |
| ``` | |
| > 자세한 내용은 [웹 플레이어 가이드](./packages/web/)를 참고해 주세요. | |
| ### 커스텀 플레이어 페이지 | |
| 직접 제작한 커스텀 플레이어 페이지를 사용하려면, `@react-native-youtube-bridge/web`을 활용하여 React 기반의 플레이어 페이지를 구축할 수 있습니다. | |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
267-267: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In README-ko_kr.md around lines 267 to 281, the section title is formatted as
bold text instead of a proper markdown heading, causing lint error MD036 and
inconsistency with the English README. Replace the bold text "**커스텀 플레이어 페이지**"
with a markdown heading using "### 커스텀 플레이어 페이지" to fix the lint error and
maintain consistent styling and automatic table of contents generation.
Summary by CodeRabbit