docs(checkout): cross-link cart_id from Create Checkout#439
Open
matthutchinson wants to merge 1 commit into
Open
docs(checkout): cross-link cart_id from Create Checkout#439matthutchinson wants to merge 1 commit into
matthutchinson wants to merge 1 commit into
Conversation
The cart capability extends create_checkout with a cart_id field for cart-to-checkout conversion (defined in cart.json #/$defs/checkout). Today this is covered in prose on the cart page under 'Cart-to-Checkout Conversion', but a reader on the checkout page has no way to discover it from the Create Checkout section. Add a one-line cross-link under Create Checkout pointing to the existing cart.md#cart-to-checkout-conversion section.
9b2b471 to
ea3bab5
Compare
Contributor
|
While I see the value of this PR from a clarity standpoint, I also think we either do this for all extensions or not doing this at all. If we approve this PR we should also add a callout for every Checkout extension (Fulfillment, Discount, Buyer Consent, ..) |
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
Add a one-line cross-link from the Create Checkout section in
checkout.mdto the existing Cart-to-Checkout Conversion section incart.md, so a reader on the checkout page can discovercart_idand the conversion contract.Why
The cart capability extends
create_checkoutwith acart_idfield (defined incart.json#/$defs/checkoutand covered in prose under Cart → Cart-to-Checkout Conversion). The cart page covers it well, but the checkout page has no signpost — a reader on/specification/checkout/#create-checkoutcannot tell that this field exists or where to find it.This adds a single discoverability hop. No content duplication.
Change
Verification
Local
mkdocs build --strictsucceeds with no non-cairosvg warnings. The cross-link resolves to../cart/#cart-to-checkout-conversion, which is a stable existing anchor.