Skip to content

docs: add quick start doc for framework mode #13864

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

Merged
merged 2 commits into from
Jun 24, 2025

Conversation

brookslybrand
Copy link
Contributor

@brookslybrand brookslybrand commented Jun 23, 2025

The Quick Start on the old Remix docs offered a nice walkthrough/explanation of all the components of the framework.

This PR moves that doc over for reactrouter.com and updates it for v7

Resolves #12812

Copy link

changeset-bot bot commented Jun 23, 2025

⚠️ No Changeset found

Latest commit: 584a2d2

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

@brookslybrand brookslybrand merged commit 4a910ac into main Jun 24, 2025
1 check passed
@brookslybrand brookslybrand deleted the brooks/framework-minimal branch June 24, 2025 13:51
## Vite Config

```shellscript nonumber
touch vite.config.js
Copy link
Member

Choose a reason for hiding this comment

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

We use TS files all over the docs, so maybe we should do that on this page as well?

Suggested change
touch vite.config.js
touch vite.config.ts

Comment on lines 58 to 59
touch app/root.jsx
touch app/routes.js
Copy link
Member

Choose a reason for hiding this comment

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

Same for these files

Suggested change
touch app/root.jsx
touch app/routes.js
touch app/root.tsx
touch app/routes.ts

export default [];
```

The existence of `routes.js` is required to build a React Router app; if you're using React Router we assume you'll want to do some routing eventually. You can read more about defining routes in our [Routing][routing] guide.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The existence of `routes.js` is required to build a React Router app; if you're using React Router we assume you'll want to do some routing eventually. You can read more about defining routes in our [Routing][routing] guide.
The existence of `routes.js` is required to build a React Router app; if you're using React Router, we assume you'll want to do some routing eventually. You can read more about defining routes in our [Routing][routing] guide.

[templates]: ../start/framework/deploying#templates
[spa]: ../how-to/spa
[inspect]: https://nodejs.org/en/docs/guides/debugging-getting-started/
[vite-config]: ../file-conventions/vite-config
Copy link
Member

Choose a reason for hiding this comment

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

This path doesn't exist and we have a link to the Vite docs

Suggested change
[vite-config]: ../file-conventions/vite-config

[inspect]: https://nodejs.org/en/docs/guides/debugging-getting-started/
[vite-config]: ../file-conventions/vite-config
[routing]: ../start/framework/routing
[templates]: /resources?category=templates
Copy link
Member

Choose a reason for hiding this comment

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

We already have a link for templates

Suggested change
[templates]: /resources?category=templates

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs]: Tutorial: React Router (framework) minimal setup
2 participants