Skip to content
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.

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

Fix: Correct module path and clarify config structure in Medusa v2 Docs #9222

Merged
merged 3 commits into from
Sep 23, 2024

Conversation

aqeebpathan
Copy link
Contributor

What

This PR addresses an issue in the Medusa v2 documentation regarding the module creation example. The import paths were corrected to reflect the proper directory structure, ensuring clarity for users.

Closes #9220

Why

The previous documentation contained incorrect import paths that could lead to confusion for users attempting to create and configure modules. Clarifying the structure aims to prevent similar issues for future users.

How

  • Updated the import statements in the documentation to go two levels up instead of three.
  • Added clarification in the medusa-config.js example to indicate that the modules node should be a part of projectConfig.

Testing

While documentation changes do not require formal testing, I reviewed the updated paths and descriptions against the current code structure to ensure accuracy and clarity.

Note

This is my first contribution to an open source project, and I'm excited to contribute to the Medusa community!

@aqeebpathan aqeebpathan requested a review from a team as a code owner September 21, 2024 16:25
Copy link

changeset-bot bot commented Sep 21, 2024

⚠️ No Changeset found

Latest commit: 0b1e44b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Sep 21, 2024

@aqeebpathan is attempting to deploy a commit to the medusajs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@damien-thiesson damien-thiesson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@olivermrbl
Copy link
Contributor

Thanks for the contribution. Will let @shahednasser take a look at it!

Copy link
Member

@shahednasser shahednasser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution, just need a small change.

@@ -74,7 +74,9 @@ In `medusa-config.js`, add a `modules` property and pass to it your custom modul

```js title="medusa-config.js" highlights={[["4", "helloModuleService", "The key of the main service to be registered in the Medusa container."]]}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```js title="medusa-config.js" highlights={[["4", "helloModuleService", "The key of the main service to be registered in the Medusa container."]]}
```js title="medusa-config.js" highlights={[["7", "helloModuleService", "The key of the main service to be registered in the Medusa container."]]}

Copy link
Member

@shahednasser shahednasser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM thanks!

@kodiakhq kodiakhq bot merged commit 3320f13 into medusajs:develop Sep 23, 2024
22 of 30 checks passed
@aqeebpathan aqeebpathan deleted the fix/medusa-v2-docs-typo branch September 23, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Medusa v2 Docs: Typo in module creation example + clarification
4 participants