Commit Graph

1574 Commits

Author SHA1 Message Date
420coupe d4173478f4 docs: digital product media content binary -> base64 as of v2.11.0 (#14497) 2026-01-13 18:53:42 +02:00
Shahed Nasser 00fc32bc37 docs: paypal integration tutorial (#14253) 2026-01-13 15:39:49 +02:00
Omar Fetooh 803ebb4ac7 Fix small typo in file name import (#14529)
## Summary

**What** — What changes are introduced in this PR?

Fix small typo in file import in the Meta product feed tutorial

**Why** — Why are these changes relevant or necessary?  

The typo in the import path causes confusion when following the Meta product feed tutorial and can lead to runtime or build errors for developers implementing the feature.
Fixing it ensures the documentation matches the actual file structure and improves the developer experience.

**How** — How have these changes been implemented?

The incorrect import path in the tutorial was corrected to reference the proper file name.
No logic or behavior was changed—only the documentation example was updated.

**Testing** — How have these changes been tested, or how can the reviewer test the feature?

This change affects documentation only.

---

## Examples

Not applicable. This PR only corrects a typo in the documentation.


## Checklist

Please ensure the following before requesting a review:

- [ ] I have added a **changeset** for this PR
    - Every non-breaking change should be marked as a **patch**
    - To add a changeset, run `yarn changeset` and follow the prompts
- [ ] The changes are covered by relevant **tests**
- [x] I have verified the code works as intended locally
- [x] I have linked the related issue(s) if applicable

---

## Additional Context
Resolves #14522



---

> [!NOTE]
> Updates the product feed tutorial to correct a typo in an import path.
> 
> - In `src/workflows/generate-product-feed.ts` snippet within `page.mdx`, change `./steps/build-product-field-xml` to `./steps/build-product-feed-xml`. Documentation-only; no runtime code modified.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 560f3a356f696be1d05fca9931593daff3217059. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>
2026-01-13 10:45:14 +00:00
Shahed Nasser 43951ce60e docs: add npx2yarn component (#14512)
* initial

* initial

* update tests

* remove unused import

* allow passing with no tests

* vale fixes
2026-01-12 13:42:30 +02:00
github-actions[bot] 673627044b chore(docs): Updated UI Reference (automated) (#14507)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action


---

> [!NOTE]
> Applies patch updates to the Medusa UI stack across the monorepo.
> 
> - Bumps `@medusajs/icons` to `2.12.5`, `@medusajs/ui` to `4.0.33`, and `@medusajs/ui-preset` to `2.12.5`
> - Updates affected apps/packages: `api-reference`, `book`, `cloud`, `resources`, `ui`, `user-guide`, `docs-ui`, `tailwind`, and `types`
> - Refreshes `yarn.lock` accordingly
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 756527915a20240054463bd83b93888d5dc0f5da. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2026-01-09 13:19:10 +00:00
Shahed Nasser baaee11114 docs: updates for storefront in cloud (#14491)
* docs: updates for storefront in cloud

* comment-out pnpm

* fix broken link

* npm prerequisites

* Update www/apps/cloud/app/storefront/page.mdx

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

* remove global cdn

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
2026-01-08 17:39:19 +02:00
Shahed Nasser 7161cf1903 docs: auth in cloud + restructure deployment guides (#14457)
* docs: auth in cloud + restructure deployment guides

* added details about enabling cloud auth

* fix vale errors
2026-01-07 13:51:23 +02:00
github-actions[bot] d6d7d14a6a chore(docs): Generated References (automated) (#14471)
Generated the following references:
- `analytics`
- `analytics_provider`
- `api_key`
- `api_key_models`
- `auth`
- `auth_models`
- `cart`
- `cart_models`
- `core_flows`
- `currency`
- `currency_models`
- `customer`
- `customer_models`
- `event`
- `events`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `fulfillment_provider`
- `inventory_next`
- `inventory_next_models`
- `js_sdk`
- `medusa`
- `module_events`
- `modules`
- `modules_sdk`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `pricing`
- `pricing_models`
- `product`
- `product_models`
- `promotion`
- `promotion_models`
- `region`
- `region_models`
- `sales_channel`
- `sales_channel_models`
- `stock_location_next`
- `stock_location_next_models`
- `store`
- `store_models`
- `tax`
- `tax_models`
- `tax_provider`
- `translation`
- `translation_models`
- `types`
- `user`
- `user_models`
- `utils`
- `workflows`


---

> [!NOTE]
> No changes to summarize — the provided diff was empty.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit fe58b669976b04475e6d0f16eb185976cb527d3b. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2026-01-06 17:30:16 +00:00
github-actions[bot] 1af99f8d5c chore(docs): Updated API Reference (automated) (#14470)
* chore(docs): Generated API Reference (automated)

* fixes

* fix locale header

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2026-01-06 19:00:02 +02:00
Shahed Nasser 76ff8dcca8 docs: fix locale option passed to query (#14472) 2026-01-06 18:59:44 +02:00
github-actions[bot] 893da93feb chore(docs): Updated UI Reference (automated) (#14469)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action


---

> [!NOTE]
> Updates Medusa UI-related dependencies to latest patch versions across the docs monorepo.
> 
> - Bumps `@medusajs/icons` to `2.12.4` in `api-reference`, `book`, `cloud`, `resources`, `user-guide`, `docs-ui`, and `types`
> - Bumps `@medusajs/ui` to `4.0.32` in `api-reference`, `ui`, and `docs-ui`
> - Bumps `@medusajs/ui-preset` to `2.12.4` in `ui` and `tailwind`
> - Refreshes `yarn.lock` to reflect new versions
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eac21c3aa042fd700e27e762e79200d76cf48ef5. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2026-01-06 16:21:11 +00:00
Shahed Nasser a2210ea5e7 docs: docs for next release (#14456) 2026-01-06 17:40:26 +02:00
Shahed Nasser 4d632e7a5d docs: added tests for components in api-reference project (#14428)
* add tests (WIP)

* added test for h2

* finished adding tests

* fixes

* fixes

* fixes
2026-01-05 10:56:56 +02:00
calebro fb772f0f6a docs: fix PostHog API Key link (#14433)
Update PostHog API Key link in page.mdx
2026-01-05 09:43:48 +02:00
Arpit Goyal 353f4712a0 docs: fix typo in Medusa API key instructions (#14435)
* Fix typo in Medusa API key instructions

* Update www/apps/resources/app/nextjs-starter/page.mdx

---------

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2026-01-05 09:42:52 +02:00
Shahed Nasser 1ed6e6b308 docs: add examples for migrations (#14420) 2025-12-30 15:42:34 +02:00
Shahed Nasser e110c08970 docs: add how-to guide for removing country code in storefront prefix (#14419) 2025-12-30 13:01:55 +02:00
Shahed Nasser 1de4d1e700 docs: use 200 for routes response across docs (#14418) 2025-12-30 09:36:10 +02:00
Shahed Nasser ba3a572a89 docs: various improvements to introduction guides (#14398) 2025-12-24 15:37:37 +02:00
Shahed Nasser dc52dfd1dd docs: small fixes and improvements to text (#14385) 2025-12-22 17:06:25 +02:00
Shahed Nasser cb33388202 docs: add line highlight validation (#14380)
* docs: add line highlight validation

* add to all projects

* fixes

* fixes

* fix

* fixes
2025-12-22 14:10:39 +02:00
Shahed Nasser 797878af26 docs: fix total descriptions across docs (#14366) 2025-12-19 15:31:28 +02:00
Shahed Nasser fb11f0f272 docs: fixes related to troubleshooting (#14353) 2025-12-18 17:00:59 +02:00
Shahed Nasser 7172995bde docs: add vite configuration to docker guide (#14352) 2025-12-18 15:52:27 +02:00
Shahed Nasser 1c4c4b8e9a docs: generate references manually for 2.12.3 (#14340) 2025-12-17 18:20:19 +02:00
Shahed Nasser 52e965f411 docs: generate API reference for 2.12.3 (#14341) 2025-12-17 18:19:46 +02:00
Shahed Nasser 07bb931254 docs: document cloud sign in methods, usage and add-on changes (#14333) 2025-12-17 16:27:34 +02:00
github-actions[bot] 663bc8f662 chore(docs): Generated + Updated UI Reference (automated) (#14336)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-12-17 15:50:04 +02:00
Shahed Nasser c1a5390fc6 docs: translation module (#14271)
* docs: translation module

* fix link in JS SDK

* add translations user guides [WIP]

* updates

* fix broken link

* remove mentions of default locale

* change header

* updates

* updated user guides

* handle todos

* fix build error

* fix lint errors
2025-12-17 13:07:43 +02:00
Shahed Nasser 4bf0dac97d docs: update next and react (#14288) 2025-12-12 09:55:13 +02:00
github-actions[bot] dbc592cd80 chore(docs): Generated + Updated UI Reference (automated) (#14285)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-12-11 16:40:35 +02:00
Shahed Nasser 62c637d709 docs: updates for next release (#14275) 2025-12-11 15:56:34 +02:00
Shahed Nasser c26f5643b6 docs: improve build with AI chapter (#14259)
* docs: improve build with AI chapter

* update sidebar
2025-12-09 16:59:39 +02:00
Shahed Nasser 0084460765 docs: various improvements and fixes (#14257) 2025-12-09 16:16:45 +02:00
Shahed Nasser 75eac9ebec docs: okta integration tutorial (#14188)
* initial

* docs: okta integration tutorial
2025-12-09 08:36:31 +02:00
Shahed Nasser e3e3c725db docs: triage issues + revamp troubleshooting guides (#14216)
* docs: triage issues + revamp troubleshooting guides

* small change
2025-12-04 17:12:48 +02:00
github-actions[bot] a00bba5cfc chore(docs): Updated UI Reference (automated) (#14212)
* chore(docs): Generated + Updated UI Reference (automated)

* install deps

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-12-04 15:05:10 +02:00
Shahed Nasser a33ef1e4d9 docs: update Next.js + React (#14210) 2025-12-04 11:50:25 +02:00
Bastien 7652329489 docs: add custom admin route ranking documentation (#13984)
## Summary

**What** — What changes are introduced in this PR?

Related PR #13946 
Add custom admin route ranking documentation 

**Why** — Why are these changes relevant or necessary?  

*Please provide answer here*

**How** — How have these changes been implemented?

*Please provide answer here*

**Testing** — How have these changes been tested, or how can the reviewer test the feature?

*Please provide answer here*

---

## Examples

Provide examples or code snippets that demonstrate how this feature works, or how it can be used in practice.  
This helps with documentation and ensures maintainers can quickly understand and verify the change.

```ts
// Example usage
```

---

## Checklist

Please ensure the following before requesting a review:

- [ ] I have added a **changeset** for this PR
    - Every non-breaking change should be marked as a **patch**
    - To add a changeset, run `yarn changeset` and follow the prompts
- [ ] The changes are covered by relevant **tests**
- [ ] I have verified the code works as intended locally
- [ ] I have linked the related issue(s) if applicable

---

## Additional Context

Add any additional context, related issues, or references that might help the reviewer understand this PR.


---

> [!NOTE]
> Adds admin UI docs for sidebar route ranking (including nested), sorting rules, and examples using CodeTabs; mirrors updates in the public content file.
> 
> - **Docs (Admin UI Routes)** in `www/apps/book/app/learn/fundamentals/admin/ui-routes/page.mdx`:
>   - Add `rank` property to `defineRouteConfig` docs and explain sidebar ordering.
>   - New section: "Specify UI Route Sidebar Rank" with version note (v2.11.4).
>   - Add sorting rules for ranked vs. unranked routes.
>   - Add "Nested UI Routes Ranking" with examples under `orders`.
>   - Provide two example routes (Analytics, Reports) demonstrating rank via `CodeTabs`/`CodeTab` (and import them).
>   - Minor copy tweaks (e.g., possessive fix in `label` description).
> - **Public content mirror** in `www/apps/book/public/llms-full.txt`:
>   - Sync the above additions: `rank` property, ranking section, sorting rules, nested ranking examples, and copy fixes.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 1d127afbfb01e034c39b0b02081781bd0a8e29ef. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-12-03 15:41:43 +00:00
Shahed Nasser 2087c8d155 docs: add best practices doc for third-party syncing (#14203)
* docs: add best practices doc for third-party syncing

* small fix
2025-12-03 15:47:41 +02:00
github-actions[bot] 471ab72ecb chore(docs): Generated References (automated) (#14199)
Generated the following references:
- `api_key_models`
- `auth_models`
- `auth_provider`
- `caching`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `fulfillment_models`
- `inventory_next_models`
- `js_sdk`
- `order_models`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`


---

> [!NOTE]
> Regenerates API reference pages across models, workflows/steps, and JS SDK, and updates generated Typedoc JSON and edit-dates script.
> 
> - **Documentation**:
>   - **Models References**: Regenerated pages under `apps/resources/references/*_models/variables` for `api_key`, `auth`, `cart`, `currency`, `customer`, `fulfillment`, `inventory_next`, `order`, `payment`, `pricing`, `product`, `promotion`, `region`, `sales_channel`, `stock_location_next`, `store`, `tax`, `user`.
>   - **Core Flows**: Added/updated `Workflows_*` and `Steps_*` reference pages across modules including `Api_Key`, `Auth`, `Cart`, `Common`, `Customer`, `Customer_Group`, `Defaults`, `Draft_Order`, `File`, `Fulfillment`, `Inventory`, `Invite`, `Line_Item`, `Order`, `Payment`, `Payment_Collection`, `Price_List`, `Pricing`, `Product`, `Product_Category`, `Promotion`, `Region`, `Reservation`, `Return_Reason`, `Sales_Channel`, `Settings`, `Shipping_Options`, `Shipping_Profile`, `Stock_Location`, `Store`, `Tax`, `User`.
>   - **JS SDK**: Added `js_sdk.admin.Admin.order` property and `admin.Order.updateOrderChange` method references.
>   - **Types**: Added `types/CachingTypes.interfaces.ICachingModuleService` reference.
> - **Generated Assets**:
>   - Updated `utils/generated/typedoc-json-output/0-medusa.json` and `0-types.json`.
>   - Updated `apps/resources/generated/edit-dates.mjs`.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 796f722aa33abd2033f488a33e0df81903b1b3f2. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2025-12-03 12:01:29 +00:00
github-actions[bot] b3bcfb7b49 chore(docs): Generated API Reference (automated) (#14200)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-12-03 12:11:56 +02:00
Shahed Nasser fe3c28488c docs: improve CORS troubleshooting guide (#14194) 2025-12-03 08:45:21 +02:00
Shahed Nasser 00052b9e50 docs: track code copy + AI assistant event (#14193)
* docs: track code copy + AI assistant event

* add pathname to callback
2025-12-02 17:24:31 +02:00
Shahed Nasser 0158554020 docs: strapi integration guide (#14075) 2025-12-02 12:30:47 +02:00
Shahed Nasser 9372a17d1f docs: generate API reference for 2.12.0 (#14185) 2025-12-02 11:56:37 +02:00
github-actions[bot] 21f61ec160 chore(docs): Generated References (automated) (#14182)
Generated the following references:
- `api_key_models`
- `auth_models`
- `cart_models`
- `core_flows`
- `currency_models`
- `customer_models`
- `file`
- `file_service`
- `fulfillment`
- `fulfillment_models`
- `helper_steps`
- `inventory_next_models`
- `js_sdk`
- `module_events`
- `modules`
- `notification`
- `notification_service`
- `order`
- `order_models`
- `payment`
- `payment_models`
- `pricing_models`
- `product_models`
- `promotion`
- `promotion_models`
- `region_models`
- `sales_channel_models`
- `stock_location_next_models`
- `store_models`
- `tax_models`
- `types`
- `user_models`
- `utils`
- `workflows`


---

> [!NOTE]
> Regenerates documentation references with updated schemas/fields and source links, adds locking guidance to fulfillment delivery workflow, expands notification step IO, and tweaks examples/sample values.
> 
> - **Docs Generation**:
>   - Regenerated reference pages across `core_flows`, `fulfillment`, `inventory`, `order`, etc., with updated TypeList schemas and examples.
> - **Fulfillment Workflows/Steps**:
>   - Updated IO schemas (e.g., added `custom_display_id` on `OrderDTO`, `carry_over_promotions` on `OrderChangeDTO`).
>   - Added locking guidance and workflow steps (`acquireLockStep`/`releaseLockStep`) to `markFulfillmentAsDeliveredWorkflow` plus new note/tag.
>   - Refreshed example snippets and sample values.
> - **Notification Step** (`sendNotificationsStep`):
>   - Input expanded with `from`, `content`, `provider_data`, `attachments`; `template` now optional.
>   - Output includes `provider_data` and `attachments` fields.
> - **Order Steps/Workflows**:
>   - IO schemas updated to include `custom_display_id` and `carry_over_promotions` where applicable; added `ordering` on change actions.
>   - Example payloads adjusted (IDs, currencies, amounts).
> - **Meta**:
>   - Updated `<SourceCodeLink>` URLs to new commit hashes throughout.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit eeb0dac7b19d51860531a491208b2b3b853aa4db. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-12-02 06:59:52 +00:00
github-actions[bot] aba10608ae chore(docs): Updated UI Reference (automated) (#14181)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action


---

> [!NOTE]
> Bumps Medusa UI-related dependencies across apps/packages and updates DatePicker prop type metadata in UI specs.
> 
> - **Dependencies**:
>   - Upgrade `@medusajs/icons` to `2.12.0` across apps/packages.
>   - Upgrade `@medusajs/ui` to `4.0.28` in `apps/api-reference`, `apps/ui`, and `packages/docs-ui`.
>   - Upgrade `@medusajs/ui-preset` to `2.12.0` in `apps/ui` and `packages/tailwind`.
>   - Update `yarn.lock` accordingly.
> - **UI Reference**:
>   - Update `DatePicker` prop type metadata for `onBlur`, `onFocus`, `onKeyDown`, and `onKeyUp` in `apps/ui/specs/components/DatePicker/DatePicker.json`.
> 
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 222e08dc7d3aa920103aa9b35c50207dca4dd32f. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>


Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2025-12-02 06:52:50 +00:00
Shahed Nasser 223ccb4add docs: docs for next release (#14110) 2025-12-01 20:20:01 +02:00
Shahed Nasser d9e3965a10 docs: fix highlights in digital products recipe (#14171) 2025-12-01 13:41:14 +02:00