react-navigation.github.io icon indicating copy to clipboard operation
react-navigation.github.io copied to clipboard

docs: Adding troubleshooting info

Open denissb opened this issue 4 years ago • 1 comments

Motivation

When trying out the next version of @react-navigation/stack the NavigationContainer fails to mount with an error "TypeError: Cannot read property 'SafeAreaProviderCompat' of undefined"

There is a comment here: https://github.com/react-navigation/react-navigation/blob/main/packages/elements/src/MaskedViewNative.tsx#L17, but it can take some time to find the cause of the error.

Instead it is better to mention the error in the troubleshooting guide for the people who want to try out the new version on their existing projects.

READ ME PLEASE!

TL;DR: Make sure to add your changes to versioned docs

Thanks for opening a PR!

The docs cover several versions of react-navigation, and in some cases there are several files (for version 1, version 2 and etc.) that all describe a single page of the docs (eg. "Getting Started").

Please make sure that the edit you're making in docs/file-you-edited.md is also included in the file for the correct version, eg. /versioned_docs/version-3.x/file-you-edited.md for version 3. If such file doesn't exist, please create it. :+1:

denissb avatar Jul 14 '21 08:07 denissb

:heavy_check_mark: Deploy Preview for react-navigation-docs ready!

:hammer: Explore the source changes: 7b7f5c9286bffab23138ad890add286967023fa5

:mag: Inspect the deploy log: https://app.netlify.com/sites/react-navigation-docs/deploys/60ee9cc9174f1600082f0619

:sunglasses: Browse the preview: https://deploy-preview-1020--react-navigation-docs.netlify.app

netlify[bot] avatar Jul 14 '21 08:07 netlify[bot]

Thanks for the PR, however, this doesn't look like a common problem, but a bug. Can you open an issue in React Navigation repo with a repro so we can fix it?

satya164 avatar Oct 31 '22 23:10 satya164