Brohammad / Brohammad/VoxForge

Document invite email (Resend/SMTP) in the deployment guide

Open Beginner friendly
#45 0 comments 0 reactions 0 assignees View on GitHub
documentation help wanted
Dominant language
Python
Stars
4
Forks
1
Avg merge
5d 13m
Merged PRs (30d)
10

Description

## Task

`InviteEmailSender` supports `log`, `resend`, and `smtp`. `docs/CONFIGURATION.md` lists the vars; `docs/deployment/guide.md` does not walk operators through turning on real invite email for pilots.

## Context

- `src/voxforge/infrastructure/email/invite_mailer.py`
- `docs/CONFIGURATION.md` (`EMAIL_PROVIDER`, `RESEND_API_KEY`)
- `docs/release/known-limitations.md` (log mode)
- `docs/deployment/verification-checklist.md`

## Acceptance criteria

- [ ] Deployment guide section: log vs resend vs smtp
- [ ] Invite-only + `REGISTRATION_ENABLED=false` called out
- [ ] Checklist item for “invite email actually arrives”
- [ ] No secrets in examples

Contributor guide

Open the contributing guide

Research direction

Start with docs/deployment/guide.md and compare its configuration guidance with docs/CONFIGURATION.md and src/voxforge/infrastructure/email/invite_mailer.py. Review docs/release/known-limitations.md for log mode and docs/deployment/verification-checklist.md for the appropriate checklist location. Done means the guide covers log, resend, and smtp, explains invite-only registration, uses no secrets, and checks that an invite email arrives.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devops, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.