Qoute Management Documentation #623
Open
Conversation
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
Generated documentation for quote-management B2B drop-in. Documentation includes: - Overview and quick start guides - Functions API reference with examples - Events reference with usage scenarios - Container and slot documentation - Styles customization guide - Dictionary for i18n - Initialization configuration Files: 24 pages Preview available in b2b-documentation branch. Part of B2B documentation initiative.
Event headers use '(emits and listens)' format, so anchors should be -emits-and-listens not -emits
Individual dropin branches should build without referencing other dropins. Full B2B navigation exists on b2b-documentation preview branch.
- Added comprehensive function enrichments (descriptions, examples, error handling) - Added detailed event enrichments (integration examples, best practices) - Added container enrichments (features, configuration, customization) - Added overview enrichments (introduction, supported features, B2B integration) All rich content extracted from initial-quote-management-dropin-docs branch and verified to be preserved for future regenerations.
Updated all bidirectional event links to use -emits-and-listens suffix.
Added quote-management bidirectional events to emitsAndListensByDropin map. This ensures future regenerations use correct -emits-and-listens suffix for all bidirectional events across all dropins. Fixes anchor link validation errors for: - quote-management/initialized - quote-management/negotiable-quote-close-error - quote-management/negotiable-quote-closed - quote-management/permissions - quote-management/quantities-updated - quote-management/quote-data - quote-management/quote-duplicated - quote-management/quote-items-removed - quote-management/quote-renamed - quote-management/quote-sent-for-review - quote-management/quote-template-data - quote-management/shipping-address-set
Created comprehensive workflow for managing infrastructure vs content changes: NEW FILES: - scripts/sync-release-to-dropins.sh: Automated script to propagate infrastructure changes from releases/b2b-nov-release to all dropin branches - B2B-INFRASTRUCTURE-WORKFLOW.md: Complete workflow documentation with examples, decision trees, and troubleshooting - B2B-WORKFLOW-QUICKREF.md: Quick reference card for common operations WORKFLOW SUMMARY: - Infrastructure (generators, templates) → releases/b2b-nov-release - Content (enrichments, docs) → individual dropin branches - Sync script merges release into all dropin branches automatically - Prevents duplication and ensures consistency across 5 parallel PRs USAGE: ./scripts/sync-release-to-dropins.sh [--dry-run|--push|--dropin NAME]
- Two clear sentences instead of one long sentence - Sentence 1: Core purpose with top 2 features (21 words) - Sentence 2: Additional capabilities (11 words) - Total: 32 words, improved readability - Follows CONTRIBUTING.md principles for clear, direct writing
- Created scripts/update-b2b-preview-all.sh to update b2b-documentation preview - Merges infrastructure changes from releases/b2b-nov-release - Merges content from all 5 dropin branches (company-management, company-switcher, purchase-order, quote-management, requisition-list) - Provides colored output showing merge progress - Automatically returns to original branch after update - Single command to regenerate complete preview with all changes Usage: ./scripts/update-b2b-preview-all.sh
- Changed nowrap={[0,1]} to nowrap={[0]} in all container docs
- Allows Type column to wrap naturally for better readability
- Created overview page modeled after B2C dropins overview - Lists all 5 B2B dropins with descriptions and links - Uses TableWrapper with nowrap for consistent formatting - Located at /dropins-b2b/ for B2B drop-ins section
- Added complete 'Drop-ins for B2B' section with all 5 dropins - Each dropin includes full page set: Overview, Quick Start, Initialization, Functions, Events, Containers, Slots, Styles, Dictionary - Positioned before Drop-ins SDK section - Includes new B2B overview page at /dropins-b2b/ - Company Management, Company Switcher, Purchase Order, Quote Management, Requisition List all fully represented
The overview page links to all 5 B2B dropins, but individual branches only contain one dropin's content. This causes link validation failures. The overview page should only exist on b2b-documentation preview branch where all dropin content is merged together.
# Conflicts: # _dropin-enrichments/quote-management/containers.json
…erator Enable generators to use enrichment descriptions for parameters and slots: - Check enrichment.parameters[paramName].description before using auto-generated - Check enrichment.slots[slotName].description before leaving blank - Pass enriched props/slots through to all downstream functions - Remove auto-generation of empty slot descriptions This allows developers to provide meaningful, context-rich descriptions in enrichment files that explain WHEN and WHY to use each parameter/slot, while still defaulting to empty for undocumented items.
All parameters and slots now display meaningful, context-rich descriptions: QuoteSummaryList parameters: - hideHeading: When to hide in embedded contexts - showMaxItems: Initial limit vs full display scenarios - attributesToHide: Creating simplified views - showDiscount/showSavings: Pricing transparency ManageNegotiableQuote: - File upload parameters: Attachment policies and limits - 16 slots: Customization opportunities for each UI section All descriptions explain WHEN and WHY, not just WHAT.
- Removes specific count claim to prevent maintenance issues - Count accuracy is hard to maintain as APIs evolve - Overview remains descriptive without the count
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Qoute Management Documentation
Complete documentation for the Qoute 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