Zaid Rashid
0058338d40
docs: Fix link to the correct AuthIdentity model's page ( #9519 )
...
I think there is a bug on the link to the `AuthIdentity ` model's page. The page containing the issue can be found [here](https://docs.medusajs.com/v2/resources/commerce-modules/auth/auth-identity-and-actor-types#what-is-an-auth-identity )
2024-10-10 14:41:19 +00:00
Shahed Nasser
7f1f075222
docs: improvements and fixes to components in API reference ( #9410 )
...
- Change layout of parameters for clearer display
- Fix schema code blocks being longer than container
- switch between showing required to showing optional indicator
- Fixed code tabs not having copy / report buttons
Closes DOCS-936
Preview: https://api-reference-v2-git-docs-api-ref-comp-improv-medusajs.vercel.app/v2/api/store
2024-10-09 17:51:27 +00:00
Shahed Nasser
3298cd3fd2
docs: improved commerce module docs [2/n] ( #9501 )
...
Improve + add docs for commerce modules from currency to inventory
[2/n]
2024-10-09 09:53:17 +00:00
Shahed Nasser
e23d2b9ed7
docs: updates in recipes ( #9472 )
...
Updates in recipes following release changes
2024-10-07 17:53:53 +00:00
Shahed Nasser
f3c8f5efef
docs: document using conditional operators in workflows ( #9464 )
2024-10-07 17:52:30 +00:00
Shahed Nasser
781d0ca624
docs: added docs for reset password ( #9306 )
...
- Added to docs on implementing auth flows using the module and API routes how to update a user's password
- Added guide on how to send a notification when a password token is generated
- Added a guide on implementing reset password flow in storefront
- Added OAS for the `/update` and `/reset-password` routes + generated specs for the API reference
2024-10-07 08:04:01 +00:00
Damien Thiesson
adb3a8246a
docs: fix import path in the workflow basic documentation ( #9481 )
...
The import is three levels up, but, the `src/api/workflow/route.ts` file is only two levels down from `src/workflow`.

2024-10-07 07:22:15 +00:00
Shahed Nasser
522d3ce764
docs: improvements to API reference intro sections ( #9397 )
...
- Improve intro sections of API reference to utilize divided columns
- Improve the content of the intro sections
- Add a new Workflows section to explain the workflows badge and how to use it
- Fixes to headings and add anchor for copying the link to a section
- Fixes responsiveness of intro sections on mobile devices
- Other: fix loading not showing when a sidebar category is opened.
Closes DOCS-932, DOCS-934, DOCS-937
Preview: https://api-reference-v2-git-docs-api-ref-intro-fixes-medusajs.vercel.app/v2/api/store
2024-10-06 16:51:08 +00:00
Shahed Nasser
ed174826a4
docs: update modules chapter in basics ( #9452 )
...
* docs: update modules chapter in basics
* address PR feedback
2024-10-04 14:15:41 +03:00
Shahed Nasser
bc8de8e5b1
docs: add section on testing providers ( #9453 )
2024-10-04 10:29:45 +03:00
Shahed Nasser
00a51b59b1
docs: update imports of middlewares and http types ( #9440 )
2024-10-03 15:56:58 +00:00
Shahed Nasser
1bb3f8b5b1
docs: add a troubleshooting guide for dist imports ( #9442 )
2024-10-03 14:17:48 +03:00
Shahed Nasser
ab5a7ca691
docs: fix infinite scroll, update next.js, other fixes ( #9441 )
...
* update nextjs
* badge + scroll fixes
2024-10-03 14:17:33 +03:00
c536f7caf5
chore(docs): Generated References (automated) ( #9436 )
...
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com >
Co-authored-by: Shahed Nasser <shahednasser@gmail.com >
2024-10-03 11:03:35 +03:00
github-actions[bot] and Shahed Nasser
21badd069d
chore(docs): Updated API Reference (v2) ( #9437 )
...
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-10-03 07:48:54 +00:00
Zaid Rashid
c4f26120b0
docs: Fix typo. Use instead yuse ( #9431 )
...
Fix typo. Use instead of use. I found this while reading through the documents here https://docs.medusajs.com/v2/resources/references/auth/provider#validatecallback
2024-10-02 16:01:14 +00:00
Shahed Nasser
0f6f56e764
docs: DX and performance improvements in API reference ( #9430 )
...
- Improve scroll behavior between active sections
- Improve lag when clicking on a sidebar item
- Refactor internal working of the `SidebarProvider` to find active items faster.
- Use Next.js's `useRouter` hook for changing the hash (since they added the option to disable scroll)
- Change `isBrowser` from a hook to a provider since it's widely used across applications.
- Other general improvements and fixes.
Closes DOCS-952
2024-10-02 15:51:02 +00:00
github-actions[bot] and kodiakhq
34eebb61eb
chore(docs): Generated References (automated) ( #9419 )
...
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com >
2024-10-02 17:13:09 +02:00
Shahed Nasser
9811da2960
docs: fix query option in instrumentation ( #9395 )
2024-10-02 10:29:11 +03:00
Shahed Nasser
8686ca9d12
docs: updates and fixes in utils + fulfillment provider changes ( #9347 )
...
* fix config + update deps
* rearrange sidebar + add to examples
2024-10-02 10:27:48 +03:00
Shahed Nasser
07afa8fba6
docs: fix how api reference shows any type ( #9340 )
2024-10-02 10:27:21 +03:00
Shahed Nasser
fb67d90b64
docs: improvements + additions to module docs ( #9152 )
...
- Split Module and Module Links to their own chapters
- Add new docs on db operations and transactions in modules, multiple services, links with custom columns, etc...
- Added a list of registered dependencies in a module container
2024-10-01 11:20:54 +00:00
Shahed Nasser
1ad7e7583f
docs: fix imports from dist ( #9401 )
2024-10-01 09:49:37 +00:00
arun-prasath2005
9bd99df545
Update page.mdx ( #9366 )
...
Spelling issue with perform, Fixed it!
2024-10-01 09:46:45 +00:00
Shahed Nasser
2e16949979
docs: update imports and package names across docs ( #9375 )
...
* docs: update imports and package names across docs
+ reference configs
* generate files
* fix import
* change preview to rc
2024-10-01 11:03:42 +02:00
Shahed Nasser
b3a204e974
docs: document InferTypeOf ( #9321 )
...
- Add documentation on how to use InferTypeOf
- Use InferTypeOf in recipes and examples
2024-09-26 13:42:29 +00:00
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] and kodiakhq
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] and Oli Juhl
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] and Oli Juhl
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] and kodiakhq
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