Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing step on "Navigating Between Screens" section in react native documentation #3862

Closed
JuszJo opened this issue Sep 28, 2023 · 8 comments

Comments

@JuszJo
Copy link
Contributor

JuszJo commented Sep 28, 2023

Description

According to the official react navigation documentation https://reactnavigation.org/docs/getting-started, after installing all dependencies for react navigation to work, there is an extra step required for the "react-screens" package to work properly on android devices that is missing from the "Navigating Between Screens" section in https://reactnative.dev/docs/navigation#react-navigation.

What is the problem?

It requires an extra configuration in the MainActivity.java file which is located in android/app/src/main/java/<your package name>/MainActivity.java in order for react navigation to work properly on android devices.

How can we address it?

A simple solution would just be to update the documentation for just this problem as it is an important step in process of using react navigation for android devices.

Why is it important?

It would provide more clarity to the process of setting up a react native app for navigation

Who needs this?

All devs alike will need this as it is a crucial step in setting up a react native app for navigation

When should this happen (use version numbers if needed)?

Since this is a documentation issue, I believe it should happen in the next minor updates

@cortinico
Copy link
Contributor

It requires an extra configuration in the MainActivity.java file which is located in android/app/src/main/java/<your package name>/MainActivity.java in order for react navigation to work properly on android devices.

We should probably update this page to point to the onboarding page of react-navigation rather than having to keep up with the instruction changes

@JuszJo
Copy link
Contributor Author

JuszJo commented Sep 29, 2023

It requires an extra configuration in the MainActivity.java file which is located in android/app/src/main/java/<your package name>/MainActivity.java in order for react navigation to work properly on android devices.

We should probably update this page to point to the onboarding page of react-navigation rather than having to keep up with the instruction changes

Yes that can also be a solution

@cortinico
Copy link
Contributor

Are you up for sending a PR for it @JuszJo ?

@JuszJo
Copy link
Contributor Author

JuszJo commented Sep 29, 2023

Are you up for sending a PR for it @JuszJo ?

Yes, I would like to.

@JuszJo
Copy link
Contributor Author

JuszJo commented Oct 2, 2023

Hey @cortinico, I have opened a PR for this issue.

@cortinico
Copy link
Contributor

Hi @JuszJo, my comment was to remove the setup instructions for react-navigation and point to their setup page instead. Please update your PR accordingly.

@JuszJo
Copy link
Contributor Author

JuszJo commented Oct 2, 2023

Oh, will do that. thank you

@cortinico
Copy link
Contributor

Closed by #3866

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

No branches or pull requests

2 participants