Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@grahamcrackers
Copy link
Contributor

@grahamcrackers grahamcrackers commented Dec 19, 2025

Description

Updated all documentation references from the package names (@adobe/commerce-events-sdk and @adobe/commerce-events-collectors) to the current package names (@adobe/magento-storefront-events-sdk and @adobe/magento-storefront-event-collector).

The packages were attempted to be renamed at some point, but the documentation still contained mixed references to both the old and new package names, which could cause confusion for users trying to install or reference these packages.

Related Issue

N/A - Documentation cleanup to fix inconsistent package naming

Motivation and Context

The codebase had inconsistent package name references:

  • The package.json files used the correct @adobe/magento-storefront-* naming
  • The README files had mixed references to both old (@adobe/commerce-events-*) and new names
  • This created confusion about which package names users should actually use when installing or importing

This change ensures all documentation consistently uses the current official package names.

How Has This Been Tested?

  • Verified all references to commerce-events-collectors and commerce-events-sdk have been removed using grep
  • Confirmed package.json files already contained the correct package names
  • No code changes were made, only documentation updates

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes. (N/A - documentation only)
  • All new and existing tests passed.

Files Changed

packages/storefront-events-collector/README.md

  • Updated CDN script tag reference
  • Updated npm install command
  • Updated import statement example
  • Updated npm package link
  • Updated TypeScript badge and search links

packages/storefront-events-sdk/README.md

  • Updated CDN script tag reference
  • Updated npm install command
  • Updated import statement example
  • Updated TypeScript badge and search links

packages/storefront-events-collector/package.json

  • Fixed homepage URL to reference correct package directory path

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants