Skip to content

docs: Move react-email to dev dependencies in install guides #1522

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

Conversation

PCRinus
Copy link
Contributor

@PCRinus PCRinus commented Jun 30, 2024

react-email can be installed as a dev dependency, instead of a dependency that we need to ship at runtime, thus saving bundle space. Adjust the documentation for all package managers to reflect this.

This has been mentioned initially in this issue thread: #1101

Side by side comparison

image image

Copy link

vercel bot commented Jun 30, 2024

@PCRinus is attempting to deploy a commit to the resend Team on Vercel.

A member of the Team first needs to authorize it.

@gabrielmfern gabrielmfern force-pushed the canary branch 2 times, most recently from 8a41d44 to a0a0c9a Compare July 1, 2024 13:49
@PCRinus PCRinus force-pushed the docs-add-react-email-to-dev-dependecies branch from ab9ef34 to 0908efb Compare July 1, 2024 15:04
@gabrielmfern gabrielmfern force-pushed the canary branch 3 times, most recently from e001f5e to f5cf05c Compare July 3, 2024 21:41
@PCRinus PCRinus force-pushed the docs-add-react-email-to-dev-dependecies branch 3 times, most recently from a97d9fa to e4e1e6e Compare July 7, 2024 08:50
@gabrielmfern gabrielmfern force-pushed the canary branch 2 times, most recently from d1a7c8d to 296473d Compare July 23, 2024 17:44
Copy link
Collaborator

@gabrielmfern gabrielmfern left a comment

Choose a reason for hiding this comment

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

Could you make all --save-dev flags into just the shorthand form, i.e., -D?

@PCRinus PCRinus force-pushed the docs-add-react-email-to-dev-dependecies branch from e4e1e6e to e974fe1 Compare August 25, 2024 16:20
Copy link

changeset-bot bot commented Aug 25, 2024

⚠️ No Changeset found

Latest commit: 05fb2c5

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

`react-email` can be installed as a dev dependency, instead of a dependency that we need to ship at runtime, thus saving bundle space
@PCRinus PCRinus force-pushed the docs-add-react-email-to-dev-dependecies branch from e974fe1 to 05fb2c5 Compare August 25, 2024 16:26
@PCRinus
Copy link
Contributor Author

PCRinus commented Aug 25, 2024

@gabrielmfern Sorry for the delay, I've changed all the dev flags to their shorthand version.

I would keep the -D and -E flags separate instead of chaining them (-DE), since it seems easier to read and research those flags in case someone is not aware what they do.

Also, do we need to generate a changeset for this small change?

@gabrielmfern
Copy link
Collaborator

Thanks for making the changes!

Also, do we need to generate a changeset for this small change?

Nope, changeset is only meant for when changing something in a package that would require a subsequent versioning change.

@gabrielmfern gabrielmfern merged commit e2004cb into resend:canary Aug 27, 2024
4 of 6 checks passed
@PCRinus PCRinus deleted the docs-add-react-email-to-dev-dependecies branch August 28, 2024 08:37
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.

2 participants