Quote Management Documentation #656
Conversation
This PR adds the quote-management dropin documentation (24 files). Enrichment files are already in the base branch (releases/b2b-nov-release). Base: releases/b2b-nov-release
- Convert all parameter descriptions to verb-first, action-oriented form - Provide useful context beyond parameter names - Fix array examples to use escaped code formatting - Fix 'When set to true' patterns to verb-first form
jcalcaben
left a comment
jcalcaben
left a comment
There was a problem hiding this comment.
Initial technical review feedback of a few files. Review still in progress.
| }, | ||
| "ShippingAddressDisplay": { | ||
| "description": "The ShippingAddressDisplay container shows the selected shipping address for a quote with options to change or add new addresses. This component integrates with the company address book for B2B customers." | ||
| "description": "The ShippingAddressDisplay container shows the selected shipping address for a quote with options to change or add new addresses. This component integrates with the company address book for B2B customers.", |
There was a problem hiding this comment.
Error/Mistake: The container by itself only renders the shipping address or a warning. The feature for setting a new address from the address book is a boilerplate customization that is not part of the dropin.
| "description": "The ShippingAddressDisplay container shows the selected shipping address for a quote with options to change or add new addresses. This component integrates with the company address book for B2B customers.", | |
| "description": "The ShippingAddressDisplay container shows the selected shipping address for a quote or a warning if there is no shipping address set.", |
|
|
||
| ### `quote-management/file-upload-error` (emits) | ||
|
|
||
| Emitted when a specific condition or state change occurs. |
There was a problem hiding this comment.
issue (vague): Event description is not very specific or helpful.
NOTE: The table above also needs to be updated.
| Emitted when a specific condition or state change occurs. | |
| Emitted when there is an error during the file upload process. |
|
|
||
| events.on('quote-management/initialized', () => { | ||
| console.log('Quote Management ready'); | ||
| loadQuotesList(); |
There was a problem hiding this comment.
issue: This is a weird example since this is not how you would load the quotes list.
suggestion: Maybe omit this line and just stick to the console log?
|
|
||
| ### `quote-management/line-item-note-set` (emits) | ||
|
|
||
| Emitted when a specific condition or state change occurs. |
There was a problem hiding this comment.
issue (vague): Event description is not very specific or helpful.
NOTE: The table above also needs to be updated.
| Emitted when a specific condition or state change occurs. | |
| Emitted after note has been set for a line item in a quote. |
|
|
||
| ### `quote-management/negotiable-quote-close-error` (emits and listens) | ||
|
|
||
| Emitted and consumed for internal and external communication. |
There was a problem hiding this comment.
issue (vague): Event description is not very specific or helpful.
NOTE: The table above also needs to be updated.
| Emitted and consumed for internal and external communication. | |
| Emitted when there is an issue closing a negotiable quote. |
|
|
||
| ### `quote-management/negotiable-quote-deleted` (emits) | ||
|
|
||
| Emitted when a specific condition or state change occurs. |
There was a problem hiding this comment.
issue (vague): Event description is not very specific or helpful.
NOTE: The table above also needs to be updated.
| Emitted when a specific condition or state change occurs. | |
| Emitted after a negotiable quote has been successfully deleted. |
|
|
||
| ### `quote-management/negotiable-quote-requested` (emits) | ||
|
|
||
| Emitted when a specific condition or state change occurs. |
There was a problem hiding this comment.
issue (vague): Event description is not very specific or helpful.
NOTE: The table above also needs to be updated.
| Emitted when a specific condition or state change occurs. | |
| Emitted after a negotiable quote has been successfully requested and created. |
There was a problem hiding this comment.
issue (vague): These descriptions have no specific details about the nature of the event being emitted. I started adding comments on individual ones, but it looks like they're all the same.
suggestion: Audit and update these event descriptions.
| | [`createQuoteTemplate`](#createquotetemplate) | Creates a new negotiable quote template from an existing quote. | | ||
| | [`deleteQuote`](#deletequote) | Deletes one or more negotiable quotes. | | ||
| | [`deleteQuoteTemplate`](#deletequotetemplate) | Permanently deletes a negotiable quote template. | | ||
| | [`duplicateQuote`](#duplicatequote) | API function for the drop-in.. | |
There was a problem hiding this comment.
**issue (vague):**Function description is not very specific or helpful.
| | [`duplicateQuote`](#duplicatequote) | API function for the drop-in.. | | |
| | [`duplicateQuote`](#duplicatequote) | Duplicates a negotiable quote from an existing quote. | |
| | [`setShippingAddress`](#setshippingaddress) | Sets or updates the shipping address for a negotiable quote. | | ||
| | [`updateQuantities`](#updatequantities) | Updates the quantities of items in a negotiable quote. | | ||
| | [`updateQuoteTemplateItemQuantities`](#updatequotetemplateitemquantities) | Changes the quantity of one or more items in an existing negotiable quote template. | | ||
| | [`uploadFile`](#uploadfile) | API function for the drop-in.. | |
There was a problem hiding this comment.
issue (vague): Function description is not very specific or helpful.
| | [`uploadFile`](#uploadfile) | API function for the drop-in.. | | |
| | [`uploadFile`](#uploadfile) | Uploads a file | |
…e-docs/microsite-commerce-storefront into b2b-docs-quote-management-v2
…merce-docs/microsite-commerce-storefront into b2b-docs-quote-management-v2
Restore enrichment and checkout files to match the base branch state. These files should remain unchanged in this PR as they are not part of the Quote Management documentation.
bdenham
force-pushed
the
b2b-docs-quote-management-v2
branch
from
d2d4e8f to
602be5a
Compare
- Remove parameters from other B2B drop-ins - Remove generic container parameters - Keep only ariaLabel and onCompanyChange
…ment-v2 # Conflicts: # _dropin-enrichments/company-switcher/containers.json # _dropin-enrichments/quote-management/containers.json
Feature branches now receive safeguard files (Git hooks, GitHub Actions, publication docs) when merged from releases/b2b-nov-release. The validation script needs to explicitly allow these files: - .githooks/ directory - .github/workflows/ (safeguard workflows) - All .md files (includes PUBLISH-B2B-README.md, etc.) This prevents false validation failures on feature branches.
Changed pattern from ^\.github/workflows/ to ^\.github/ to include files like .github/PULL_REQUEST_TEMPLATE_PUBLICATION.md This was causing validation failures because the PR template is in .github/ root, not in workflows/ subdirectory.
The validation workflow is blocking all PRs. Disabling it temporarily to unblock the team while we diagnose the root cause. The workflow file is renamed to .yml.disabled so it won't run.
Change broken links from /merchants/blocks/targeted-block/ to /merchants/commerce-blocks/personalization/ to fix build errors.
Applied same fixes as b2b-preview (commit e70bec4): - Complete B2B dropins sidebar with all 4 dropins - Restored 30 B2B commerce block files - Added B2B Commerce blocks section to sidebar
There was a problem hiding this comment.
Please explain this change
3 participants
Note: This PR supersedes #623 with a cleaner file structure for easier review.
Quote Management Documentation
Complete documentation for the Quote Management B2B drop-in.
📖 Preview
Full preview with all dropins: https://commerce-docs.github.io/microsite-commerce-storefront/dropins-b2b/quote-management/
📁 Files Added
✅ Review Checklist
Part of #600 - B2B Documentation Initiative