-
Notifications
You must be signed in to change notification settings - Fork 4
Add notice about vouchers to the bulky item docs #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Sorry, was me making this PR, wrong account 😅 |
There was a problem hiding this 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 enhances the bulky items documentation by adding guidance on how to add vouchers to tokens when using certain gateways, specifically addressing a practical requirement for the mailer gateway.
- Adds a new documentation section explaining when and how to add vouchers to tokens
- Provides a concrete PHP code example showing how to format vouchers for the mailer gateway
- Includes a minor whitespace fix at the end of the file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Toflar
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't really like this addition because it's confusing to me.
Of course you need to add it as a token? Everything that can be selected by the users must be a token.
So to me, it's the other way around. You don't need to "also add it as a token". You always need to add it as a token if you want users to be able to select them. Only tokens can be selected.
But if you want to provide file type tokens (FileTokenDefinition or AnythingTokenDefinition), you also have to add the voucher IDs via stamp. The reasons for that are already documented right in that article :)
What exactly happened that you created this PR? Did you just add bulky item vouchers via stamp but no tokens? Why?
Presumably because the documentation currently says
My assumption is that this is meant as a generalized example and thus not necessarily reflect how the Mailer gateway that ships with the Notification Center does it. |
|
The docs in short say: create a bulky item and add the voucher as a stamp — done. |
Since I stumbled over this topic this week, I propose to add a notice about adding the vouchers to tokens.