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

docs: added a service factory reference #8292

Merged
merged 5 commits into from
Jul 26, 2024
Merged

Conversation

shahednasser
Copy link
Member

Added a service factory reference of the generated methods and how to use them.

Since the types in the codebase are a bit complex, a generated reference won't provide a valuable result.

Instead, this reference is created manually and aims to cover common use cases, providing examples for them.

Closes DOCS-844

@shahednasser shahednasser requested a review from a team as a code owner July 26, 2024 08:04
Copy link

vercel bot commented Jul 26, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
api-reference 🔄 Building (Inspect) Visit Preview 💬 Add feedback Jul 26, 2024 2:35pm
api-reference-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 26, 2024 2:35pm
docs-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 26, 2024 2:35pm
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 26, 2024 2:35pm
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 26, 2024 2:35pm
resources-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 26, 2024 2:35pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Jul 26, 2024 2:35pm

Copy link

changeset-bot bot commented Jul 26, 2024

⚠️ No Changeset found

Latest commit: b97f6ec

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
Contributor

@olivermrbl olivermrbl left a comment

Choose a reason for hiding this comment

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

This is great @shahednasser – essentially, what I talked about the other day.

Minor nit and totally non-blocking: We could change customModuleService to postModuleService now that we are working with a post model.

@shahednasser
Copy link
Member Author

@olivermrbl got point! Will make the change 👍🏻

@shahednasser shahednasser changed the title docs: added a service factory referene docs: added a service factory reference Jul 26, 2024
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.

2 participants