Skip to content

Clarify email delivery in local development#6863

Merged
aduth merged 2 commits intomainfrom
aduth-readme-emails
Aug 30, 2022
Merged

Clarify email delivery in local development#6863
aduth merged 2 commits intomainfrom
aduth-readme-emails

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Aug 29, 2022

From some anecdotal feedback I've heard from developers:

  • Some have expected that the application would send real emails
    • Clarify that the application does not send real emails
  • Some would test email template changes by going through the real flows
    • Clarify that Rails template previews exist to simplify this process

To better emphasize the common workflows, I also chose to remove some of the details around running Mailcatcher on a different host or port. I think this could be useful information for someone at some point, but I don't think I've ever used it in my time on the program, so it felt like a detail that could be omitted from the top-level documentation.

From some anecdotal feedback I've heard from developers:

- Some have expected that the application would send real emails
   - Clarify that the application does not send real emails
- Some would test email template changes by going through the real flows
   - Clarify that Rails template previews exist to simplify this process

changelog: Internal, Documentation, Improve onboarding documentation for application emails
Copy link
Contributor

@zachmargolis zachmargolis left a comment

Choose a reason for hiding this comment

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

LGTM

See: #6863 (comment)
Co-Authored-By: Zach Margolis <zbmargolis@gmail.com>
@aduth aduth merged commit 2a56c74 into main Aug 30, 2022
@aduth aduth deleted the aduth-readme-emails branch August 30, 2022 12:58
@aduth aduth mentioned this pull request Aug 30, 2022
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