Skip to content

Add v3 and v4 documentation - #28

Merged
JonoB merged 3 commits into
masterfrom
v3-v4-docs
Oct 12, 2026
Merged

JonoB merged 3 commits into
masterfrom
v3-v4-docs

Conversation

@JonoB

@JonoB JonoB commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

The docs currently stop at v2, but SendPortal has been on v3 (Laravel 11) since April 2024, and v4 (Laravel 13) is in progress: mettle/sendportal-core#226, mettle/sendportal#343.

Each version is a copy of the previous one with targeted changes; review the two commits separately to see each diff.

v3 (as at release, April 2024)

  • Requirements: PHP 8.2+. Laravel 11 for the stand-alone app; Laravel 10 or 11 for the package.
  • New Postal page (Postal support was added in core 2.0.4 but never documented). Covers host and API key setup and the six webhook events SendPortal handles.
  • Mailgun: the Webhook Key field (core 2.0.5). Without it, webhooks are rejected and tracking stops.
  • Package installation: new Laravel 11 apps have no routes/api.php (php artisan install:api), and the API example uses auth:sanctum instead of an auth:api guard that default apps don't define.
  • horizon:publish kept, with a note that it does nothing from Horizon 5.24.4.
  • New v2 → v3 upgrade guide (stand-alone and package).
  • Fixes "the following five email service providers", which listed six.

v4

  • Requirements: PHP 8.3+, Laravel 13 for the stand-alone app, Laravel 12 or 13 for the package, PostgreSQL 10+.
  • Removes the horizon:publish step and uses make:queue-table.
  • New v3 → v4 upgrade guide, covering the CSRF middleware rename and why staying on v3 is risky.

API pages are unchanged; the API hasn't changed since v2.

Both versions

  • Image paths are absolute (https://sendportal.io/img/...), so screenshots also show when the docs are viewed on GitHub. This is the same fix as Enhancement - Absolute Image Paths #2, applied to every image in v3 and v4.

JonoB added 3 commits October 12, 2026 09:27
Copied from v2 and updated for SendPortal v3 (Laravel 11):
- Requirements: PHP 8.2+, Laravel 11 (stand-alone) / Laravel 10 or 11 (package)
- New Postal email service page
- Mailgun webhook key setting
- v2 to v3 upgrade guide
- Package install notes for Laravel 11 apps without routes/api.php
- Note that horizon:publish is a no-op from Horizon 5.24.4

Amp-Thread-ID: https://ampcode.com/threads/T-01a12ce4-5849-7298-9b52-0f19594ee434
Copied from v3 and updated for SendPortal v4 (Laravel 13):
- Requirements: PHP 8.3+, Laravel 13 (stand-alone) / Laravel 12 or 13
  (package), PostgreSQL 10+
- v3 to v4 upgrade guide
- Drop the horizon:publish step and use make:queue-table

Amp-Thread-ID: https://ampcode.com/threads/T-01a12ce4-5849-7298-9b52-0f19594ee434
Image paths like /img/... only resolve on sendportal.io. Using
https://sendportal.io/img/... makes the images show when the docs are
viewed on GitHub too (same fix as #2).

Amp-Thread-ID: https://ampcode.com/threads/T-01a12ce4-5849-7298-9b52-0f19594ee434
@JonoB
JonoB merged commit 60aa65d into master Oct 12, 2026
@JonoB
JonoB deleted the v3-v4-docs branch October 12, 2026 09:29
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