Skip to content

Conversation

@saseungmin
Copy link
Owner

@saseungmin saseungmin commented Oct 12, 2025

Summary by CodeRabbit

  • Documentation

    • Pin 1.x install commands to react-native-gesture-image-viewer@1.x.
    • Switch 2.x install commands from beta to stable (remove @beta).
    • Update example project links (1.x → v1.x paths, 2.x → main branch).
    • Correct hero/Quick Start links for English and Korean across versions.
  • Chores

    • Set documentation default version to 2.x and update edit links to main.
    • Adjust install snippet to show @1.x only for 1.x; use stable otherwise.
    • Remove deprecated v1 example screen from the example app.

@changeset-bot
Copy link

changeset-bot bot commented Oct 12, 2025

⚠️ No Changeset found

Latest commit: 87cc327

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

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

@coderabbitai
Copy link

coderabbitai bot commented Oct 12, 2025

Walkthrough

Docs updated across 1.x and 2.x to adjust install commands and links (pin 1.x, remove @beta for 2.x, update example links and hero paths). Docs config switches default version to 2.x and updates edit links. Theme install snippet now varies by version. V1Example component removed from the example app.

Changes

Cohort / File(s) Summary of Changes
Docs 1.x (EN) install/quick-start
docs/docs/1.x/en/guide/getting-started/installation.mdx, docs/docs/1.x/en/guide/getting-started/quick-start.mdx
Pin install command to react-native-gesture-image-viewer@1.x; update example link to v1.x.
Docs 1.x (EN) index
docs/docs/1.x/en/index.md
Update hero Quick Start link to /1.x/guide/getting-started/installation.html.
Docs 1.x (KO) install/quick-start
docs/docs/1.x/ko/guide/getting-started/installation.mdx, docs/docs/1.x/ko/guide/getting-started/quick-start.mdx
Pin install command to @1.x; update example link to v1.x.
Docs 1.x (KO) index
docs/docs/1.x/ko/index.md
Update hero Quick Start link to /1.x/ko/guide/getting-started/installation.html.
Docs 2.x (EN) install/quick-start
docs/docs/2.x/en/guide/getting-started/installation.mdx, docs/docs/2.x/en/guide/getting-started/quick-start.mdx
Remove @beta from install; switch example link from next to main.
Docs 2.x (EN) index
docs/docs/2.x/en/index.md
Change hero Quick Start link to unversioned /guide/getting-started/installation.html.
Docs 2.x (KO) install/quick-start
docs/docs/2.x/ko/guide/getting-started/installation.mdx, docs/docs/2.x/ko/guide/getting-started/quick-start.mdx
Remove @beta from install; switch example link to main.
Docs 2.x (KO) index
docs/docs/2.x/ko/index.md
Change hero Quick Start link to /ko/guide/getting-started/installation.html.
Docs config
docs/rspress.config.ts
Set multiVersion.default to 2.x; update editLink repo base URLs from next to main.
Docs theme
docs/theme/index.tsx
Install snippet logic: use @1.x when version is 1.x; otherwise plain package (no @beta).
Example app
example/src/V1Example.tsx
Remove V1Example component and all related code (default export deleted).

Sequence Diagram(s)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Poem

A nibble of docs, a hop through time,
1.x pinned, 2.x in its prime.
Snippets switch with gentle grace,
Links now point to the proper place.
Farewell V1, we tip our ear—
New trails beckon, the path is clear. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The provided title describes documentation updates relating to version tags and links for the v2.x release, but the pull request also removes the entire V1Example component and makes updates to example code and configuration that are not reflected in the title, so it does not fully summarize the main changes. Please update the title to encompass both the documentation changes and the removal of the V1Example example component, for example: “docs: update version tags and links and remove V1Example for v2.x release.”
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/v2.x-release

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d517a41 and 87cc327.

📒 Files selected for processing (15)
  • docs/docs/1.x/en/guide/getting-started/installation.mdx (1 hunks)
  • docs/docs/1.x/en/guide/getting-started/quick-start.mdx (2 hunks)
  • docs/docs/1.x/en/index.md (1 hunks)
  • docs/docs/1.x/ko/guide/getting-started/installation.mdx (1 hunks)
  • docs/docs/1.x/ko/guide/getting-started/quick-start.mdx (2 hunks)
  • docs/docs/1.x/ko/index.md (1 hunks)
  • docs/docs/2.x/en/guide/getting-started/installation.mdx (1 hunks)
  • docs/docs/2.x/en/guide/getting-started/quick-start.mdx (2 hunks)
  • docs/docs/2.x/en/index.md (1 hunks)
  • docs/docs/2.x/ko/guide/getting-started/installation.mdx (1 hunks)
  • docs/docs/2.x/ko/guide/getting-started/quick-start.mdx (2 hunks)
  • docs/docs/2.x/ko/index.md (1 hunks)
  • docs/rspress.config.ts (2 hunks)
  • docs/theme/index.tsx (1 hunks)
  • example/src/V1Example.tsx (0 hunks)
💤 Files with no reviewable changes (1)
  • example/src/V1Example.tsx
🧰 Additional context used
🧬 Code graph analysis (3)
docs/docs/1.x/en/guide/getting-started/quick-start.mdx (2)
example/src/Example.tsx (1)
  • Example (22-206)
src/GestureViewer.tsx (1)
  • GestureViewer (11-185)
docs/docs/2.x/en/guide/getting-started/quick-start.mdx (2)
example/src/Example.tsx (1)
  • Example (22-206)
src/GestureViewer.tsx (1)
  • GestureViewer (11-185)
docs/docs/1.x/ko/guide/getting-started/quick-start.mdx (1)
example/src/Example.tsx (1)
  • Example (22-206)
🔇 Additional comments (11)
docs/docs/2.x/ko/index.md (1)

11-11: LGTM! Hero link correctly points to the 2.x installation guide.

The relative path /ko/guide/getting-started/installation.html will correctly resolve to the 2.x Korean installation page from this 2.x index file.

docs/theme/index.tsx (1)

29-29: LGTM! Version-aware installation command implemented correctly.

The conditional logic properly displays @1.x for 1.x documentation and removes the @beta suffix for 2.x documentation, aligning with the release objectives.

docs/rspress.config.ts (2)

13-13: LGTM! Default version updated to 2.x for the new release.

This change makes 2.x the default documentation version, which is appropriate for the v2.x release.


48-48: LGTM! Edit links updated to point to the main branch.

Both English and Korean edit links now correctly reference the main branch instead of next, aligning with the stable release.

Also applies to: 56-56

docs/docs/1.x/ko/guide/getting-started/quick-start.mdx (2)

11-11: LGTM! Example project link correctly points to the v1.x branch.

This ensures users viewing 1.x documentation are directed to the appropriate example code for that version.


23-23: LGTM! Installation command properly pinned to 1.x version.

The @1.x tag ensures users following the 1.x guide install the correct major version.

docs/docs/1.x/ko/guide/getting-started/installation.mdx (1)

80-80: LGTM! Installation command properly pinned to 1.x version.

This ensures users following the 1.x installation guide install the correct major version with the @1.x tag.

docs/docs/2.x/en/guide/getting-started/quick-start.mdx (2)

11-11: LGTM! Example project link updated to the main branch.

This correctly points users to the stable example code for the v2.x release.


23-23: LGTM! Beta tag removed from installation command.

The removal of @beta is appropriate for the v2.x stable release, allowing users to install the latest stable version.

docs/docs/1.x/ko/index.md (1)

11-11: LGTM! Hero link correctly points to the 1.x installation guide.

The absolute path /1.x/ko/guide/getting-started/installation.html ensures users are directed to the 1.x version of the installation guide from the 1.x Korean index.

docs/docs/2.x/en/guide/getting-started/installation.mdx (1)

85-85: LGTM! Beta tag removed from installation command.

The removal of @beta is appropriate for the v2.x stable release, allowing users to install the latest stable version directly.


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.

@cloudflare-workers-and-pages
Copy link

Deploying react-native-gesture-image-viewer with  Cloudflare Pages  Cloudflare Pages

Latest commit: 87cc327
Status: ✅  Deploy successful!
Preview URL: https://487eb053.react-native-gesture-image-viewer.pages.dev
Branch Preview URL: https://docs-v2-x-release.react-native-gesture-image-viewer.pages.dev

View logs

@saseungmin saseungmin merged commit 3df81a0 into main Oct 12, 2025
6 checks passed
@saseungmin saseungmin deleted the docs/v2.x-release branch October 12, 2025 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants