docs: migrate README content to docs site and update homepage #62
Conversation
- Move detailed documentation from README to dedicated docs site - Update package.json homepage field to point to new docs URL - Full documentation is available at: https://react-native-gesture-image-viewer.pages.dev
🦋 Changeset detectedLatest commit: 43d95af The changes in this PR will be included in the next version bump. 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 |
|
Caution Review failedThe pull request is closed. WalkthroughThis update migrates detailed documentation from the README files to a dedicated documentation website, updating all references and example usages to point to the new site. The README files in both English and Korean are condensed, focusing on quick start links and minimal examples, while the package homepage now points to the new documentation URL. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant README
participant Documentation Site
User->>README: Visit README on GitHub
README->>User: Show brief intro, key features, quick start link
User->>Documentation Site: Click link to full documentation
Documentation Site->>User: Provide detailed setup, API, and examples
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested labels
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✨ 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 comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying react-native-gesture-image-viewer with
|
| Latest commit: |
43d95af
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d1358dd3.react-native-gesture-image-viewer.pages.dev |
| Branch Preview URL: | https://docs-readme.react-native-gesture-image-viewer.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: 4
🧹 Nitpick comments (8)
.changeset/silver-states-serve.md (1)
5-8: Wrap bare URL to satisfy Markdown lint rule (MD034).
markdownlint-cli2flagged the naked URL on Line 8.
Enclose it in angle brackets or convert it to a Markdown link to silence the linter and keep formatting consistent.- - Full documentation is available at: https://react-native-gesture-image-viewer.pages.dev + - Full documentation is available at: <https://react-native-gesture-image-viewer.pages.dev>docs/docs/en/guide/getting-started/quick-start.mdx (1)
56-61: Optional: Clarify layout of navigation controls.With no styling the buttons/text will stack vertically and may cover the image.
Consider adding a horizontalflexDirection: 'row'style or wrap in a separate snippet comment so newcomers get a cleaner UI.
Example:<View style={{ flexDirection: 'row', gap: 8, alignItems: 'center' }}> … </View>docs/docs/ko/guide/getting-started/quick-start.mdx (1)
46-51: 네비게이션 버튼 레이아웃 개선 제안.스타일이 없으면 버튼/텍스트가 세로로 쌓여 이미지 위를 가릴 수 있습니다.
간단한flexDirection: 'row'스타일 예시를 주석으로 추가하면 이해가 쉬워집니다.README.md (3)
5-7: Add alt text for accessibility (MD045).Both images lack an
altattribute. Supply short descriptive text.- <img src="/assets/logo.png" width="400px" /> + <img src="/assets/logo.png" width="400px" alt="React Native Gesture Image Viewer logo" />
15-17: Second image also missing alt text.- <img src="./assets/example.gif" width="600" /> + <img src="./assets/example.gif" width="600" alt="Gesture and zoom demo" />
74-79: Minor UI polish suggestion for example layout.Add
flexDirection: 'row'or similar styling to avoid vertical stacking of controls in copied examples.README-ko_kr.md (2)
5-7: Add descriptivealttext for accessibility complianceBoth the logo image (Line 6) and the animated GIF further down the document currently omit the
altattribute, violating WCAG and triggeringmarkdownlintrule MD045. Screen-reader users will not get any context for these visuals.- <img src="/assets/logo.png" width="400px" /> + <img src="/assets/logo.png" width="400px" alt="React Native Gesture Image Viewer logo" />Please apply the same fix to the example GIF at Line 16.
35-35: Wrap bare URL in Markdown link syntaxLine 35 contains a naked URL, flagged by
markdownlintrule MD034. Rendering engines may not auto-link it, and it breaks consistency with the rest of the document.-전체 문서는 https://react-native-gesture-image-viewer.pages.dev 에서 확인할 수 있습니다. +전체 문서는 <https://react-native-gesture-image-viewer.pages.dev> 에서 확인할 수 있습니다.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
assets/logo.pngis excluded by!**/*.png
📒 Files selected for processing (6)
.changeset/silver-states-serve.md(1 hunks)README-ko_kr.md(1 hunks)README.md(1 hunks)docs/docs/en/guide/getting-started/quick-start.mdx(2 hunks)docs/docs/ko/guide/getting-started/quick-start.mdx(2 hunks)package.json(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: in react native gesture handler, the pinch gesture event.scale always starts from 1.0 at the beginni...
Learnt from: saseungmin
PR: saseungmin/react-native-gesture-image-viewer#4
File: src/useGestureImageViewer.ts:184-207
Timestamp: 2025-07-02T17:37:07.501Z
Learning: In React Native Gesture Handler, the pinch gesture event.scale always starts from 1.0 at the beginning of each new pinch gesture and is relative/multiplicative, not absolute. To maintain smooth scaling, you need to multiply the current scale by event.scale rather than directly assigning it.
Applied to files:
docs/docs/ko/guide/getting-started/quick-start.mdxdocs/docs/en/guide/getting-started/quick-start.mdxREADME.md
🪛 markdownlint-cli2 (0.17.2)
.changeset/silver-states-serve.md
8-8: Bare URL used
(MD034, no-bare-urls)
README.md
6-6: Images should have alternate text (alt text)
(MD045, no-alt-text)
16-16: Images should have alternate text (alt text)
(MD045, no-alt-text)
35-35: Bare URL used
(MD034, no-bare-urls)
37-37: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
README-ko_kr.md
6-6: Images should have alternate text (alt text)
(MD045, no-alt-text)
16-16: Images should have alternate text (alt text)
(MD045, no-alt-text)
35-35: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (1)
package.json (1)
77-77: Confirm homepage DNS / HTTPS redirects.The new homepage URL looks good. Double-check that:
https://react-native-gesture-image-viewer.pages.dev/(trailing slash) correctly redirects or serves identical content.- Any badges (npm, GitHub, etc.) in documentation still resolve after this change.
No action required if both conditions are met.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/docs/en/guide/getting-started/quick-start.mdx (1)
56-61: Add accessibility labels for navigation buttons.
Using</>astitlevalues is not descriptive for screen-reader users. Consider addingaccessibilityLabel(or a more descriptivetitle) so the sample promotes good a11y practices.-<Button title="<" onPress={goToPrevious} /> +<Button + title="<" + accessibilityLabel="Previous image" + onPress={goToPrevious} /> ... -<Button title=">" onPress={goToNext} /> +<Button + title=">" + accessibilityLabel="Next image" + onPress={goToNext} />README.md (1)
37-41: Fix markdown heading spacing (MD019).
### Examples & Democontains two spaces after the hashes. Single-space keeps the heading valid and silences markdown-lint.-### Examples & Demo +### Examples & Demo
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README-ko_kr.md(1 hunks)README.md(1 hunks)docs/docs/en/guide/getting-started/quick-start.mdx(2 hunks)docs/docs/ko/guide/getting-started/quick-start.mdx(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/docs/ko/guide/getting-started/quick-start.mdx
- README-ko_kr.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: in react native gesture handler, the pinch gesture event.scale always starts from 1.0 at the beginni...
Learnt from: saseungmin
PR: saseungmin/react-native-gesture-image-viewer#4
File: src/useGestureImageViewer.ts:184-207
Timestamp: 2025-07-02T17:37:07.501Z
Learning: In React Native Gesture Handler, the pinch gesture event.scale always starts from 1.0 at the beginning of each new pinch gesture and is relative/multiplicative, not absolute. To maintain smooth scaling, you need to multiply the current scale by event.scale rather than directly assigning it.
Applied to files:
docs/docs/en/guide/getting-started/quick-start.mdxREADME.md
🪛 markdownlint-cli2 (0.17.2)
README.md
37-37: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
⏰ 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). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
docs/docs/en/guide/getting-started/quick-start.mdx (1)
30-33: Import list now complete – good catch!
Textwas missing in the previous revision and is now included, preventing copy-paste runtime errors in examples.README.md (1)
48-50: Import list corrected – issue resolved.
Texthas been added to the React-Native import, addressing the runtime error noted in earlier reviews.
Summary by CodeRabbit