Add link to email samples from the User Guide

Open
#5,694 0 comments 0 reactions 1 assignee View on GitHub

@StephanieFarid is already working on this.

Since Aug 29, 2026.

Assessment

This issue has not been assessed yet.

Description

Ruby for Good 2026 DC

Summary

We send several different emails, let's give Bank Organizations previews!

Background references, notes

We send a variety of emails, including some that can be customized and ones that can be enable/disabled. For each of these it'd be good to show a sample of what this email will look like.

For each email we send:

  • From the place where that email is configured or sent
  • Link to the User Guide with a pre-created sample of what the email looks like
  • If there is an enable/disable option, place the link near that option
  • For example, when creating a partner we ask "Do you want this partner to receive emails for distributions and reminders from the system?". Add a link to the User Guide next to that which shows what the email will look like in general
  • For each email, trigger the email in your development environment locally and copy/paste that into the User Guide
  • Optional/Experimental: Write a script that generates a page (or pages) in the User Guide with the emails; consider triggering a PR-create process from a github action
Image

Criteria for completion / testing needs

  • Enumerate email sends
  • For each email ensure the User Guide has a sample output of the email
  • For each email link to the User Guide from where the email is configured or sent
  • Add a request spec that verifies that the links work (are not dead)

The markdown files have previously been created and added to the docs, this ticket is for adding links to the docs where the emails would be sent

Dominant language
Ruby
Stars
593
Forks
594
Avg merge
4d 22h
Merged PRs (30d)
41

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rubyforgood/human-essentials

All issues in rubyforgood/human-essentials

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.