Skip to content

Add link to email samples from the User Guide #5694

Description

@StephanieFarid

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

Activity

  1. added this to the RFG 2026 milestone on Aug 29, 2026
  2. github-actions commented on Sep 29, 2026

    @github-actions
    Contributor

    This issue is marked as stale due to no activity within 30 days. If no further activity is detected within 7 days, it will be unassigned.

  3. github-actions commented on Oct 6, 2026

    @github-actions
    Contributor

    Automatically unassigned after 7 days of inactivity.

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions