Skip to content

Doc modification and email initial verification - #6

Merged
Devathmaj merged 4 commits into
mainfrom
email-and-deploy-update
Jul 28, 2026
Merged

Doc modification and email initial verification#6
Devathmaj merged 4 commits into
mainfrom
email-and-deploy-update

Conversation

@Devathmaj

@Devathmaj Devathmaj commented Jul 28, 2026

Copy link
Copy Markdown
Owner

Description

This PR makes deployment easier and more flexible for new users, fixes the email verification flow, and improves the overall onboarding experience in the README.

Changes include:

  • Deployment guide overhaul — Moved the "Connect via Public Git Repository" alternative out of Step 6 into a dedicated "Alternate Ways to Connect Your Project" section at the end of the guide. Added a new "Connect via Existing Docker Image" path with screenshots (render_19–23) for users who prefer to deploy from the pre-built GitHub Container Registry image instead of connecting a repository. Step 4 now links to these alternatives.
  • Email verification fix — The app now sends a fresh verification email on each startup, not just the first launch. This ensures users always receive the welcome/confirmation email for new deployments or restarts.
  • README rewrite — Simplified language, reorganized into a clearer step-by-step flow (fork → download .env → complete setup guides → deploy), and replaced technical jargon with plain English to make the project accessible to non-developers.
  • LICENSE correction — Content fixes to the license file.
  • New images — 5 deployment screenshots + 1 VoucherBot preview screenshot added to docs/images/.
  • Ruff formatting fix — Corrected minor formatting in voucherbot/services/email/sender.py.

Type of Change

  • Bug fix
  • New feature
  • New source
  • Configuration / settings change
  • Database migration
  • Documentation update
  • Refactor (no functional change)
  • Other: Deployment UX improvements

Affected Components

  • Scheduler / Dispatcher
  • HTTP Policy Layer (http_policy.py)
  • RSS Collector
  • Website Collector
  • Reddit Integration
  • AI Layer (Groq / Gemini)
  • Email Notifications
  • Database / Migrations
  • API / Routers
  • Configuration / Settings
  • Documentation

Testing

  • Ran pytest — all tests pass
  • Ran ruff check . && ruff format . — no lint errors
  • Ran python scripts/verify_sources.py — all sources resolve (if sources were added or modified)
  • Added unit tests for new business logic
  • Added integration tests using fixtures or recorded responses (no live network calls)
  • Mocked Reddit API client in all new tests
  • Mocked Groq / Gemini responses in all new tests

Policy Checklist

Not applicable — no policy-sensitive files were modified.

AI Layer Changes

Not applicable — no prompts, output schema, or provider logic were modified.

Additional Notes

All CI quality checks pass: formatting, lint, mypy type checks, and the full test suite (160 passed, 15 skipped).

@Devathmaj
Devathmaj merged commit fce321d into main Jul 28, 2026
8 checks passed
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.

1 participant