Skip to content

docs: document missing ENV variables for mailing and assets#833

Open
rewritten wants to merge 1 commit intocoopdevs:developfrom
rewritten:fix/827-document-mailer-env-vars
Open

docs: document missing ENV variables for mailing and assets#833
rewritten wants to merge 1 commit intocoopdevs:developfrom
rewritten:fix/827-document-mailer-env-vars

Conversation

@rewritten
Copy link
Contributor

Summary

  • Adds missing MAILER_SENDER to README ENV table and .env.example — the sender address for all Devise emails (fixes Document MAILER_SENDER #827)
  • Fixes MAIL_LINK_PROTOCOLMAIL_LINK_PROTO in README to match the actual variable name used in the code and .env.example
  • Adds RAILS_ASSET_HOST and ASSETS_PRECOMPILE which were used in config/environments/production.rb but undocumented

Test plan

  • Review README ENV table for accuracy and completeness
  • Confirm .env.example contains MAILER_SENDER with a sensible placeholder

🤖 Generated with Claude Code

…opdevs#827)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 26, 2026 13:01
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates repository documentation to better reflect the environment variables the Rails app actually reads for production assets and outbound email configuration.

Changes:

  • Documents RAILS_ASSET_HOST and ASSETS_PRECOMPILE in the README ENV table.
  • Fixes the README env var name to MAIL_LINK_PROTO to match production config.
  • Adds MAILER_SENDER to both the README and .env.example for Devise sender configuration.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Adds/mends ENV variable documentation for asset hosting/precompile and mailer URL/sender settings.
.env.example Adds MAILER_SENDER example value for local/dev configuration.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

Document MAILER_SENDER

2 participants