Skip to content

Document the default customer notifications (2.x) - #51

Open
glennjacobs wants to merge 1 commit into
nextfrom
docs/default-customer-notifications
Open

glennjacobs wants to merge 1 commit into
nextfrom
docs/default-customer-notifications

Conversation

@glennjacobs

Copy link
Copy Markdown
Collaborator

Summary

Companion to lunarphp/lunar#2724, which ships nine branded, overridable default customer notifications for the order lifecycle in 2.x.

  • 2.x/reference/notifications.mdx (rewritten): the default set and what each email contains; the trigger rules (rollup emails only for placed orders, the refund-issued key, per-fulfilment states only, which states stay silent, the notify flags); a "Customizing the default emails" section covering the four layers in the consuming app (laravel-mail layout, lunar.views templates with the view data each receives and the shared partials, lunar.translation copy, re-registering or forgetting a key); routing and queueing notes for the defaults; the admin dropdown contents. The manifest, manual send and routing sections are kept and updated.
  • 2.x/reference/fulfilments.mdx: names the four fulfilment-state defaults in the "Notifications on fulfilment events" section.
  • 2.x/reference/orders.mdx: "Notifying the customer" now mentions the shipped defaults.
  • 2.x/extending/payments.mdx: a warning that a driver placing the order inside authorize() must record the capture before stamping placed_at, and why.
  • 2.x/getting-started/overview/upgrade-guide.mdx: a manual-checklist item for stores coming from the v1 lunar.orders.notifications config, including the refund-issued key.

No docs.json change: the notifications page already exists in the 2.x Reference navigation.

Notes

  • Targets next. The repo's CLAUDE.md says v2 content targets a 2.x branch, but no such branch exists on origin and the 2.x/ folder is maintained on next, so this follows the folder rather than the note. Happy to retarget if a 2.x branch is preferred.
  • All class names, keys, publish tags, template paths and view data were checked against the monorepo branch in Default customer notifications for the order lifecycle (spec 0036) lunar#2724.

🤖 Generated with Claude Code

Cover the branded lifecycle emails core now ships (lunarphp/lunar#2724):
the default set and what each contains, the trigger rules (placed-order
gate, the refund-issued key, per-fulfilment states only), and the four
layers for customizing them (laravel-mail layout, lunar.views templates,
lunar.translation copy, re-registering a key). Cross-reference from the
fulfilments, orders and payment-driver pages, and add an upgrade-guide
checklist item for stores migrating their v1 notification config.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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