Skip to content

Conversation

@bdenham
Copy link
Collaborator

@bdenham bdenham commented Nov 20, 2025

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

  • Overview and Quick Start
  • Functions API reference
  • Events reference
  • Containers and slots
  • Styles and i18n

✅ Review Checklist

  • Technical accuracy
  • Examples tested
  • No sensitive info
  • Developer-friendly

Part of #600 - B2B Documentation Initiative

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
@bdenham bdenham self-assigned this Nov 20, 2025
@bdenham bdenham added the new-topic A major update published as an entirely new document label Nov 20, 2025
@bdenham bdenham changed the title B2b docs quote management Qoute Management Documentation Nov 20, 2025
- 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.
@bdenham bdenham force-pushed the releases/b2b-nov-release branch from 12610e8 to e66c2d9 Compare December 7, 2025 22:56
bdenham added a commit that referenced this pull request Dec 11, 2025
KEEPING (infrastructure + merged PRs):
- Purchase Order dropin docs (merged via PR #620)
- B2B Checkout extension docs
- ALL enrichment files (104 files) - master source
- Scripts, templates, sidebar config

REMOVED (open PRs - docs live in PR branches):
- Company Management docs (PR #619 open)
- Company Switcher docs (PR open)
- Quote Management docs (PR #622 open)
- Requisition List docs (PR #623 open)
- Merchant block docs (separate PRs)

Workflow: enrichments in BOTH release + PR branches
- Release branch = master source for ALL enrichments
- PR branches = their dropin's enrichments + generated docs
bdenham added a commit that referenced this pull request Dec 11, 2025
These files were accidentally removed during cleanup but should be present
in this PR branch as they are the primary content of PR #623.

Restored complete Requisition List dropin: 14 files
These files are now in a dedicated branch for review:
- Root-level workflow documentation
- Enrichment guide files

This reduces noise in dropin-specific PRs.
- Remove files from other B2B dropins
- Keep workflow: PR should only contain quote-management documentation
- Resolves conflicts for mergeable PR
@bdenham bdenham force-pushed the b2b-docs-quote-management branch from 1b8d5d8 to fa414b6 Compare December 11, 2025 20:21
@bdenham bdenham mentioned this pull request Dec 11, 2025
4 tasks
@bdenham
Copy link
Collaborator Author

bdenham commented Dec 11, 2025

Closing in favor of #656 which has a cleaner file structure (24 files instead of hundreds) for easier review. All content has been preserved and verified.

@bdenham bdenham closed this Dec 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant