Company Management Documentation #654
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
This PR adds the company-management dropin documentation (17 files). Enrichment files are already in the base branch (releases/b2b-nov-release). Base: releases/b2b-nov-release
4 tasks
bdenham
force-pushed
the
b2b-docs-company-management-v2
branch
from
e3d4490 to
d090029
Compare
bdenham
force-pushed
the
b2b-docs-company-management-v2
branch
from
d090029 to
59b9cd5
Compare
- Convert all parameter descriptions to verb-first, action-oriented form - Provide useful context beyond parameter names - Ensure consistency across all Company Management containers
…tation parameters
slavvka
suggested changes
Dec 12, 2025
slavvka
left a comment
slavvka
left a comment
There was a problem hiding this comment.
Thanks for the documentation work! I've added missing JSDoc to the dropin code so auto-generation will be more accurate.
PRs with JSDoc additions:
Dropin code: https://github.com/adobe-commerce/storefront-company-management/pull/67
Added JSDoc to 17 files (API functions, types, container props)
Boilerplate docs: https://github.com/adobe-commerce/aem-boilerplate-commerce/pull/996
Fixed incorrect prop docs in 2 block READMEs
Once these are merged, pull the latest dropin code and regenerate. The rest of my feedback is in separate comments above.
| "CompanyProfile": { | ||
| "description": "Manages company profile information including legal name, VAT/Tax ID, contact details, and payment/shipping configurations.", | ||
| "parameters": { | ||
| "withHeader": { |
There was a problem hiding this comment.
CompanyProfile container only supports the className parameter.
Remove these parameters:
- withHeader
- withWrapper
- approvalRuleID
- routeApprovalRulesList
- routePurchaseOrderDetails
- onBack
- onSuccess
- onError
- purchaseOrderId
- requisitionListId
- routeRequisitionList
- routeRequisitionListView
- companyId
- userId
The container implementation (CompanyProfile.tsx line 26-29) only extends HTMLAttributes, which means it only accepts standard HTML div props including className.
| import { initializers } from '@dropins/tools/initializer.js'; | ||
| import { initialize } from '@dropins/storefront-company-management'; | ||
|
|
||
| const customStrings = { |
There was a problem hiding this comment.
Should be:
const customStrings = {
'Company.shared.fields.companyName': 'Organization Name',
'Company.shared.buttons.save': 'Save Changes',
'Company.CompanyProfile.containerTitle': 'Company Profile',
};
|
We merged our PRs |
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 Company Management documentation.
bdenham
force-pushed
the
b2b-docs-company-management-v2
branch
from
ac84963 to
4d3584b
Compare
… examples - Update customStrings example to use actual dictionary keys: Company.shared.fields.companyName Company.shared.buttons.save Company.CompanyProfile.containerTitle - Replace generic placeholder keys with verified keys from dictionary
- Bump version from beta24 to beta27 - Update CSS classes for new UI components - Update dictionary keys and function descriptions - Preserve correct dictionary examples in initialization - Fix Company Switcher enrichment parameters
…gement-v2 # Conflicts: # _dropin-enrichments/company-management/containers.json # _dropin-enrichments/company-switcher/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
dshevtsov
reviewed
Dec 19, 2025
| - name: Install dependencies | ||
| if: success() || failure() | ||
| run: npm ci || npm install | ||
| run: npm ci --legacy-peer-deps || npm install --legacy-peer-deps |
Collaborator
There was a problem hiding this comment.
What was the motivation for this change? It seems to introduce the risks of increased technical debt over time. Also, there is mixing between pnpm and npm. Is it necessary to use both?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Note: This PR supersedes #619 with a cleaner file structure for easier review.
Company Management Documentation
Complete documentation for the Company Management B2B drop-in.
📖 Preview
Full preview with all dropins: https://commerce-docs.github.io/microsite-commerce-storefront/dropins-b2b/company-management/
📁 Files Added
✅ Review Checklist
Part of #600 - B2B Documentation Initiative