Commit Graph

550 Commits

Author SHA1 Message Date
Shahed Nasser
39a6780815 docs: add note about authentication opt out (#9298)
Closes #9268
2024-09-26 13:04:27 +00:00
Shahed Nasser
ea2cc974cc docs: fixes to customization docs (#9236)
Closes #9225, #9224, #9226, #9227

Closes DOCS-948, DOCS-947, DOCS-945, DOCS-946
2024-09-26 13:00:37 +00:00
Shahed Nasser
2da15ba021 docs: added architecture documentation (#9256)
* docs: added architecture documentation

* update diagrams and text

* address PR comments

* sidebar + overview fixes
2024-09-26 09:29:47 +03:00
github-actions[bot]
657a9fb90b chore(docs): Generated References (#9267)
Generated the following references:
- `medusa`
- `modules`
- `modules_sdk`
- `payment_provider`
- `workflows`
2024-09-24 07:02:49 +00:00
Mohmmed Aqeeb
64c4c828b6 Fix: Install command for Vercel deployment documentation (#9270)
### What
Updated the Install Command in the Vercel deployment section to `npm install` instead of `npm run build`.

Closes #9264 

### Why
To ensure users have the correct installation instructions for deploying Medusa Admin on Vercel.

### How
Replaced the Install Command in the documentation.

### Testing
No formal testing was performed for this documentation update, as it addresses a minor typo.
2024-09-24 06:44:29 +00:00
Mohmmed Aqeeb
3320f13f5a Fix: Correct module path and clarify config structure in Medusa v2 Docs (#9222)
### 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!
2024-09-23 13:55:32 +00:00
github-actions[bot]
4a68bc1334 chore(docs): Generated References (#9232)
Generated the following references:
- `modules`
- `modules_sdk`
- `types`
2024-09-23 07:33:39 +00:00
Shahed Nasser
c790af7834 docs: improve search to show results for all filters (#9208)
* docs: improve search to show results for all filters

* fix index ordering
2024-09-22 14:49:16 +02:00
Shahed Nasser
138523a629 docs: change navbar items + breadcrumb improvements (#9209)
- Add a new commerce module navbar item
- Rename Learning Resources to Development Resources (in navbar and across documentation content)
- Improve breadcrumbs to show categories / subcategories

Preview: https://resources-docs-git-docs-navbar-changes-medusajs.vercel.app/v2/resources
2024-09-22 12:47:35 +00:00
Shahed Nasser
6584e911e0 docs: improvements + additions to workflow docs (#9182)
Improve existing workflow docs + add missing docs
2024-09-20 15:38:32 +00:00
Shahed Nasser
a4b5d66b3e docs: updates to digital product recipe (#9165)
- Create workflow for fulfilling digital products that sends a notification + create a shipment to mark the fulfillment as fulfilled / shipped.
- Update the subscriber handling the `digital_product_order.created` event to use the workflow
- Add section on using the local notification module provider for testing purposes.
2024-09-20 14:27:18 +00:00
Shahed Nasser
2f3d15de85 docs: fix attribute name in calculated price (#9215) 2024-09-20 17:22:35 +03:00
Shahed Nasser
6a2a105cf8 fix(oas): support additional props, fix circular references patch, and other fixes (#9213)
* chore(oas): support additional props, fix circular references patch, and other fixes

* fix description

* description fixes
2024-09-20 17:22:19 +03:00
github-actions[bot]
2cb9322ef5 chore(docs): Generated References (automated) (#9206)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-09-20 09:25:55 +02:00
Shahed Nasser
8dd72acee2 docs: add an examples list documentation (#9194) 2024-09-19 16:09:29 +02:00
Shahed Nasser
db73e9b972 docs: fix link in sidebar for modules test example (#9195) 2024-09-19 16:08:36 +02:00
Shahed Nasser
bf4335f2a6 docs: improvements and fixes to API route docs (#9197)
General improvements and fixes to docs around API routes
2024-09-19 14:08:23 +00:00
github-actions[bot]
a00c2ddb31 chore(docs): Generated References (#9187)
Generated the following references:
- `modules`
2024-09-19 12:20:02 +00:00
github-actions[bot]
1c4d3f32cb chore(docs): Updated API Reference (v2) (#9174)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-09-18 11:30:02 +00:00
Shahed Nasser
0c3e3ea88a docs: customization chapter exploration (#9078)
Adds a new customizations chapter with realistic example while maintaining the linear learning journey.

Preview: https://docs-v2-git-docs-customizations-chapter-medusajs.vercel.app/v2/customization
2024-09-18 08:45:29 +00:00
github-actions[bot]
56ee4d6aad chore(docs): Updated API Reference (v2) (#9148)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-09-18 07:13:51 +00:00
github-actions[bot]
a63f6910d0 chore(docs): Generated References (automated) (#9169)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-09-18 08:07:01 +02:00
Shahed Nasser
cda5bbac78 docs: added documentation on instrumentation (#9160)
Added new documentation chapter on instrumentation and observability
2024-09-17 17:22:16 +00:00
github-actions[bot]
175ca30f4f chore(docs): Generated References (#9153)
Generated the following references:
- `api_key`
- `auth`
- `auth_provider`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `customer_models`
- `dml`
- `file`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`
2024-09-17 07:17:55 +00:00
Shahed Nasser
8d3fb7fb2b docs: use require instead of import in medusa-config.js (#9102)
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
2024-09-16 19:34:00 +02:00
Shahed Nasser
58f06be44d docs: update docs across projects following publishable API key change in store routes (#9098)
* docs: update docs across projects following publishable API key change in store routes

* rename env variable

* move subscribe route out of store
2024-09-16 16:42:08 +03:00
Shahed Nasser
0bcdcccbe2 docs: update query usage across docs (#9120)
WIP
2024-09-16 12:46:26 +00:00
Shahed Nasser
35ffaf73d7 docs: update store cURL examples in OAS (#9099) 2024-09-16 15:37:11 +03:00
Shahed Nasser
8584031041 docs: replace ModuleRegistrationName with Modules (#9142) 2024-09-16 15:30:03 +03:00
Shahed Nasser
ab4a422fc8 docs: fix import of LinkDefinition (#9143) 2024-09-16 12:09:47 +03:00
erickirt
512c6fc8ab Fixed misleading LinkDefinition import from the wrong package (#9139)
It appears that `LinkDefinition` was imported from the incorrect package. From my understanding, `remote-link.d.ts` imports it from the correct location, but the tutorial does not.

```typescript
import { ILinkModule, LinkDefinition, LoadedModule, ModuleJoinerRelationship } from "@medusajs/types";
```

Additionally, I am seeking expert assistance with Medusa's architecture. If someone could reach out to me, I would greatly appreciate any guidance or direction on developing specific components for a complex multi-vendor shipping and shopping platform. My goal is to effectively utilize the Medusa architecture and contribute back to the community as much as possible.

Thank you to the entire Medusa team. I hope my contributions have been helpful to new developers enhancing their experience with Medusa.

email: erickirt582@gmail.com
2024-09-16 07:22:47 +00:00
Shahed Nasser
a7684b45f6 docs: add new events to reference (#9121) 2024-09-13 09:22:09 +02:00
Shahed Nasser
1eccf394df docs: added docs for deleting user of actor type (#9104)
- Added to general guide on creating actor type how to delete its user later.
- Added to restaurant delivery recipe how to delete a restaurant admin
2024-09-13 07:17:36 +00:00
Shahed Nasser
41fb2aacb0 docs: fixes to long-running workflows + relationship docs (#9101) 2024-09-12 09:51:00 +03:00
Shahed Nasser
1466ca73e0 docs: added a services constraint document (#8999)
- Added a services constraint document mentioning that a service's methods must be async.
- Modify the code in the services intro document to use `async` method.
2024-09-10 18:00:23 +00:00
Shahed Nasser
e9b5f76f9a docs: add Query documentation (#9079)
- Replace remote query documentation with new Query documentation
- Add redirect from old remote query to new query documentation
- Update remote query usages across docs to use new query usage.
2024-09-10 12:31:47 +00:00
Shahed Nasser
4b663a4559 docs: document events reference (#9080)
- Remove old hidden reference files that document modules' events
- Add new events reference for workflow events
- Reference events reference in the main docs
2024-09-10 12:20:09 +00:00
Shahed Nasser
3fb2f10ccb docs: fix links to inventory model references (#9073)
Closes #9070
2024-09-10 12:18:10 +00:00
Shahed Nasser
c091cf5868 docs: add prerequisites link for test guides (#9057)
- Add a prerequisites link to test guides pointing to how to setup the testing tools
- Add in the main http / module integration guides the command to run the tests
2024-09-09 13:58:42 +00:00
Shahed Nasser
a5e8a55d63 docs: added storefront development guide on retrieving variant inventory details (#9032)
* docs: added storefront development guide on retrieving variant inventory details

* fix vale error
2024-09-09 10:02:59 +03:00
Shahed Nasser
3eb2387746 docs: fix pricing query params in storefront guide + modules restructure (#9021)
- Fix pricing query params previously using `customer_group_id` and `customer_id` as expected / accepted queries and update information around them
- Other: reorganize the introduction page of each module to show how to use it at the very beginning.
2024-09-09 06:43:43 +00:00
Shahed Nasser
b5dbf572e3 docs: document star actor types (#9044) 2024-09-06 17:38:51 +02:00
Shahed Nasser
89f21e4a60 docs: fix admin actor type -> user (#9028) 2024-09-06 17:38:33 +02:00
github-actions[bot]
95a3ac045d chore(docs): Generated References (#9034)
Generated the following references:
- `auth`
- `core_flows`
- `fulfillment`
- `modules`
- `modules_sdk`
- `order`
- `types`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-06 12:39:45 +00:00
Shahed Nasser
a28c911c24 docs: update auth docs + add new storefront guides (#9020)
* docs: update auth docs + add new storefront guides

* lint content

* fix vale error

* add callback response schema

* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* Update www/apps/resources/app/commerce-modules/auth/authentication-route/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* address PR comments

* replace google -> github

* better explanation for refresh token

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
2024-09-06 15:26:10 +03:00
github-actions[bot]
cf3c25addf chore(docs): Updated API Reference (v2) (#9033)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-06 12:25:48 +00:00
github-actions[bot]
a5748c6e1f chore(docs): Generated References (#9026)
Generated the following references:
- `modules`
- `product`
- `promotion`
- `types`
2024-09-06 08:53:22 +00:00
Shahed Nasser
abe7b66999 docs: rename admin-shared -> admin-sdk (#9008) 2024-09-06 10:33:34 +02:00
github-actions[bot]
25082c60cc chore(docs): Generated References (#9007)
Generated the following references:
- `auth`
- `auth_provider`
- `core_flows`
- `modules`
- `order_models`
- `types`
2024-09-05 10:18:20 +00:00
Shahed Nasser
951b4a8100 docs: fixes to testing tool guides (#8981) 2024-09-04 18:24:49 +00:00