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

docs(guides/migrating-react-router-app): add a warning notice #5847

Closed
wants to merge 4 commits into from

Conversation

vcheeze
Copy link

@vcheeze vcheeze commented Mar 20, 2023

Closes #4623

@changeset-bot
Copy link

changeset-bot bot commented Mar 20, 2023

⚠️ No Changeset found

Latest commit: 048f069

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 20, 2023

Hi @vcheeze,

Welcome, and thank you for contributing to Remix!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 20, 2023

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

@MichaelDeBoey MichaelDeBoey changed the title Update migration guide docs(guides/migrating-react-router-app): add a warning notice Mar 20, 2023
@@ -184,6 +184,8 @@ Inside of your `$.jsx` file, all we need to do is export the code from our old r
export { default } from "~/old-app/app";
```

<docs-warning><strong>Important:</strong> make sure `app/routes/index.[jsx|tsx]` exists in your Remix app. Remix will not automatically render your `/` React Router fallback route, which means a blank page will be rendered without the index file in the `routes` directory.</docs-warning>

Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of using a warning here, could we just change the section to be "Create an Index and a Catch-all route" and export your old app (i.e., <Routes> tree) from both?

@MichaelDeBoey MichaelDeBoey added the needs-response We need a response from the original author about this issue/PR label May 15, 2023
@github-actions
Copy link
Contributor

This PR has been automatically closed because we haven't received a response from the original author 🙈. This automation helps keep the issue tracker clean from PRs that are unactionable. Please reach out if you have more information for us! 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed docs needs-response We need a response from the original author about this issue/PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Should raise error when app/routes/index.jsx does not exist
3 participants