docs: add README for basic and vaulted checkout examples#3
Open
okxint wants to merge 1 commit into
Open
Conversation
Both examples were missing documentation entirely. Each README covers: - When to use the pattern and the business case for it - How the integration flow works end-to-end - Key implementation details and common mistakes - File structure and links to related examples
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
README.mdto two examples that had no documentation at all:examples/primer-checkout-basic/examples/primer-checkout-vaulted/Why
Both examples are linked from the root
README.mdbut had zero documentation. A developer landing in either folder had no idea what the example does, when to use it, or how to run it.What each README covers
Basic checkout:
setAttribute()is required for the client tokencheckout-completeVaulted checkout:
customerIdis required to link saved methods to a customerBoth READMEs follow the format established by
primer-checkout-themes/README.md.