Skip to content

docs: Add comprehensive B2B Quote Management drop-in documentation #500

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 9 commits into
base: releases/b2b-nov-release
Choose a base branch
from
Open

docs: Add comprehensive B2B Quote Management drop-in documentation #500

wants to merge 9 commits into from

Conversation

@jcalcaben
Copy link
Contributor

@jcalcaben jcalcaben commented Oct 8, 2025 •
edited by bdenham
Loading

Purpose of this pull request

This pull request introduces complete documentation for the B2B Quote Management drop-in component for Adobe Commerce Storefront. The documentation provides comprehensive guidance for implementing negotiable quote functionality in B2B commerce scenarios, covering installation, configuration, usage, and customization.

Changes Overview

🆕 New Documentation Files Added

Core Documentation Structure:

  • index.mdx - Overview and feature introduction
  • installation.mdx - Complete installation guide
  • initialization.mdx - Configuration and setup instructions
  • containers.mdx - Container components documentation
  • functions.mdx - API functions reference
  • events.mdx - Event-driven architecture guide
  • styles.mdx - CSS customization guide
  • dictionary.mdx - Internationalization (i18n) reference

📝 Updated Documentation Files

Navigation and Integration:

  • astro.config.mjs - Added complete navigation structure for Quote Management section
  • overview.mdx - Updated with Quote Management feature overview and key capabilities

🔧 Technical Documentation Coverage

Installation & Setup:

  • Step-by-step installation instructions for NPM and CDN
  • Package mapping and import configuration
  • GraphQL endpoint connection setup
  • Authentication and header configuration
  • Component registration and rendering

Component Architecture:

  • RequestNegotiableQuoteForm - Quote request functionality
  • ManageNegotiableQuote - Comprehensive quote management
  • ItemsQuoted - Quoted items display and management
  • QuotesListTable - Quote listing with pagination and sorting

API Integration:

  • requestNegotiableQuote() - Create new quote requests
  • getQuoteData() - Retrieve quote information
  • getCustomerData() - Customer permissions and data
  • negotiableQuotes() - List and filter quotes

Event System:

  • quote-management/negotiable-quote-requested - Quote creation events
  • quote-management/quote-data - Quote data updates
  • quote-management/permissions - Permission changes
  • Integration with Adobe Commerce Event Bus

Styling & Customization:

  • CSS custom properties for theming
  • Component-specific styling examples
  • Responsive design patterns
  • Dark mode support
  • Custom theme implementation

Internationalization:

  • Complete dictionary structure for text strings
  • Multi-language support configuration
  • Dynamic language switching
  • Localization best practices

🎯 Key Features Documented

B2B Quote Management Capabilities:

  • ✅ Request negotiable quotes from cart contents
  • ✅ Quote status management and tracking
  • ✅ Product list management with pricing controls
  • ✅ Quote actions (print, copy, delete, send for review)
  • ✅ Draft quote saving functionality
  • ✅ Permission-based access control
  • ✅ Event-driven architecture for integration
  • ✅ Comprehensive styling and theming options
  • ✅ Full internationalization support

🏗️ Documentation Quality Features

Comprehensive Coverage:

  • Complete installation workflows for different environments
  • Detailed API reference with TypeScript interfaces
  • Extensive customization examples and best practices
  • Event integration patterns for storefront components
  • Responsive design and accessibility considerations

Developer Experience:

  • Code examples for all major use cases
  • Configuration options with detailed descriptions
  • Error handling and troubleshooting guidance
  • Integration patterns with other drop-in components
  • Best practices for production implementations

Testing & Validation

  • ✅ All new documentation files follow established MDX structure
  • ✅ Navigation structure updated in astro.config.mjs
  • ✅ Cross-references and internal links properly configured
  • ✅ Code examples validated for syntax and completeness
  • ✅ Integration with existing B2B documentation section

Impact

This documentation enables developers to:

  1. Implement B2B quote management functionality quickly and effectively
  2. Customize the components to match specific business requirements
  3. Integrate with existing storefront architectures seamlessly
  4. Maintain and extend quote management features over time
  5. Localize the experience for international B2B markets

The comprehensive documentation provides everything needed to deploy production-ready B2B quote management functionality in Adobe Commerce Storefront implementations.

Associated JIRA ticket

https://jira.corp.adobe.com/browse/USF-2933

Links to source code

https://github.com/adobe-commerce/storefront-quote-management

@jcalcaben
docs: Add comprehensive B2B Quote Management drop-in documentation
adcf093 
- Add complete Quote Management section to B2B drop-ins with navigation structure
- Document all container components (RequestNegotiableQuoteForm, ManageNegotiableQuote, ItemsQuoted, QuotesListTable)
- Include installation guide with step-by-step setup instructions
- Add initialization configuration with language definitions and quote ID setup
- Document API functions for quote operations and data models
- Add event-driven architecture documentation with integration examples
- Include comprehensive styling guide with CSS custom properties and responsive design
- Update B2B overview page with Quote Management feature details
- Add missing cart/data event to checkout event handling documentation
- Add event bus usage note about drop-in specific event definitions
@jcalcaben jcalcaben requested a review from bdenham October 8, 2025 20:46
@bdenham bdenham changed the base branch from develop to releases/b2b-nov-release October 12, 2025 20:33
@bdenham bdenham marked this pull request as ready for review October 21, 2025 12:36
@bdenham bdenham marked this pull request as draft October 21, 2025 12:36
@bdenham bdenham marked this pull request as ready for review November 1, 2025 18:54
@bdenham bdenham marked this pull request as draft November 1, 2025 18:55
@bdenham
fix: remove hero actions with invalid links from homepage
9b610dc 
The hero actions duplicated the LinkCard components below and used links
that the Starlight validator couldn't resolve. Removed since LinkCards
provide the same functionality and work correctly.
@bdenham bdenham marked this pull request as ready for review November 3, 2025 23:16
@bdenham
Merge branch 'releases/b2b-nov-release' into initial-quote-management…
6aff5c9 
…-dropin-docs

Resolved conflicts:
- astro.config.mjs: Combined B2B Containers, Company Management, and Quote Management sections
- overview.mdx: Removed duplicate, using index.mdx from B2B branch as overview
@bdenham bdenham force-pushed the initial-quote-management-dropin-docs branch from 1956947 to 6aff5c9 Compare November 3, 2025 23:46
@bdenham
fix: exclude B2B pages from topic requirements
a4a63a4 
Added /dropins-b2b/** to the exclude list in starlightSidebarTopics
configuration to prevent topic association errors during build.
@bdenham bdenham added the new-topic A major update published as an entirely new document label Nov 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bdenham bdenham Awaiting requested review from bdenham

Assignees

@bdenham bdenham

@jcalcaben jcalcaben

Labels

new-topic A major update published as an entirely new document

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jcalcaben @bdenham