Skip to content

[docs] Update docs#3959

Draft
m-bert wants to merge 26 commits intomainfrom
@mbert/docs-review
Draft

[docs] Update docs#3959
m-bert wants to merge 26 commits intomainfrom
@mbert/docs-review

Conversation

@m-bert
Copy link
Contributor

@m-bert m-bert commented Feb 6, 2026

Description

In this PR, I go through each section and make sure that everything is in the same style, has correct information and there are no broken links.

Test plan

Read docs 🤓

Copilot AI review requested due to automatic review settings February 6, 2026 11:02
@m-bert m-bert mentioned this pull request Feb 6, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request updates and standardizes the documentation across the react-native-gesture-handler project. The changes focus on improving consistency, correcting links, fixing formatting issues, and reorganizing content for better readability. The documentation structure has been updated to reflect the new monorepo layout where docs are now located in packages/docs-gesture-handler/.

Changes:

  • Updated repository paths and edit URLs to reflect new packages/docs-gesture-handler/ structure
  • Improved documentation consistency by adding internal links, reorganizing sections, and wrapping code examples with CollapsibleCode components
  • Enhanced cross-referencing between related documentation pages with hyperlinks
  • Added support for Groovy syntax highlighting for Android code blocks
  • Standardized formatting and improved readability across troubleshooting, testing, installation, and gesture composition guides

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/docs-gesture-handler/docusaurus.config.js Updated editUrl path to new monorepo structure and added groovy language support
packages/docs-gesture-handler/docs/guides/troubleshooting.mdx Reorganized content, added Tabs for package managers, improved formatting and wording
packages/docs-gesture-handler/docs/guides/testing.md Restructured API documentation, improved descriptions, added links to examples
packages/docs-gesture-handler/docs/guides/quickstart/index.md Added target="_blank" to external Reanimated documentation link
packages/docs-gesture-handler/docs/fundamentals/state-manager.mdx Added hyperlink to gesture lifecycle documentation
packages/docs-gesture-handler/docs/fundamentals/reanimated-interactions.mdx Added links and removed backticks from plain text "Reanimated" mentions
packages/docs-gesture-handler/docs/fundamentals/introduction.md Added links to specific gesture types and updated documentation repository path
packages/docs-gesture-handler/docs/fundamentals/installation.mdx Reorganized sections, added macOS instructions, improved clarity of setup steps
packages/docs-gesture-handler/docs/fundamentals/gesture-detector.mdx Fixed touchAction type definition, improved SVG example, updated Reanimated link
packages/docs-gesture-handler/docs/fundamentals/gesture-composition.mdx Wrapped examples with CollapsibleCode, imported simultaneous example from external file
packages/docs-gesture-handler/docs/fundamentals/callbacks-events.mdx Removed backticks from "Reanimated" in plain text
packages/docs-gesture-handler/docs/fundamentals/animated-interactions.mdx Added links to callback documentation and useNativeDriver reference
packages/docs-gesture-handler/docs/fundamentals/_examples/simultaneous.tsx New example file for simultaneous gestures demonstration
Comments suppressed due to low confidence (4)

packages/docs-gesture-handler/docs/guides/troubleshooting.mdx:14

  • Incorrect capitalization: "Github" should be "GitHub" (capital H and capital B) to match the correct brand name.
    packages/docs-gesture-handler/docs/guides/troubleshooting.mdx:25
  • Incorrect capitalization: "Github" should be "GitHub" (capital H and capital B) to match the correct brand name.
    packages/docs-gesture-handler/docs/fundamentals/gesture-composition.mdx:9
  • The import path contains a double slash and escaped underscores. Based on other raw-loader imports in the codebase (e.g., in use-pan-gesture.mdx, use-tap-gesture.mdx), the path should use a single slash and unescaped underscores. The correct path should be './_examples/simultaneous'.
    packages/docs-gesture-handler/docs/guides/troubleshooting.mdx:65
  • The bash code block has inconsistent indentation. It has 6 spaces of indentation while other code blocks in the same TabItem have 4 spaces. This should be consistent with the surrounding code blocks for proper formatting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

defaults.
- Missing `BEGIN` and `END` events are added with data copied from first and last
passed event, respectively.
- If first event don't have `state` field, the `ACTIVE` state is assumed.
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

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

Grammar error: "don't" should be "doesn't" to agree with the singular subject "event".

Suggested change
- If first event don't have `state` field, the `ACTIVE` state is assumed.
- If first event doesn't have `state` field, the `ACTIVE` state is assumed.

Copilot uses AI. Check for mistakes.
The `GestureDetector` is a key component of `react-native-gesture-handler`. It supports gestures created either using the hooks API or the builder pattern. Additionally, it allows for the recognition of multiple gestures through [gesture composition](/docs/fundamentals/gesture-composition). `GestureDetector` interacts closely with [`Reanimated`](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started/). For more details, refer to the [Integration with Reanimated](/docs/fundamentals/reanimated-interactions) section.
The `GestureDetector` is a key component of `react-native-gesture-handler`. It supports gestures created either using the hook API or the builder pattern. Additionally, it allows for the recognition of multiple gestures through [gesture composition](/docs/fundamentals/gesture-composition). `GestureDetector` interacts closely with [`Reanimated`](https://docs.swmansion.com/react-native-reanimated/). For more details, refer to the [Integration with Reanimated](/docs/fundamentals/reanimated-interactions) section.

When using hook API, you can also integrate it directly with the [Animated API](https://reactnative.dev/docs/animated). More on that can be found in [Integreation with Animated](/docs/fundamentals/animated-interactions) section.
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

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

Spelling error: "Integreation" should be "Integration".

Suggested change
When using hook API, you can also integrate it directly with the [Animated API](https://reactnative.dev/docs/animated). More on that can be found in [Integreation with Animated](/docs/fundamentals/animated-interactions) section.
When using hook API, you can also integrate it directly with the [Animated API](https://reactnative.dev/docs/animated). More on that can be found in [Integration with Animated](/docs/fundamentals/animated-interactions) section.

Copilot uses AI. Check for mistakes.
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