Commit Graph

2342 Commits

Author SHA1 Message Date
Shahed Nasser
a2210ea5e7 docs: docs for next release (#14456) 2026-01-06 17:40:26 +02:00
Shahed Nasser
4bc15b4dc4 docs: fix styling of code elements in headers (#14440) 2026-01-05 12:49:58 +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
499dec6d31 docs: added callouts in search and AI assistant (#14421)
* docs: added callouts in search and AI assistant

* added more suggestions

* fix search tests

* add mock for links
2025-12-30 16:57:18 +02:00
Shahed Nasser
1ed6e6b308 docs: add examples for migrations (#14420) 2025-12-30 15:42:34 +02:00
Shahed Nasser
40db4c22d3 docs: added support for tests in www workspace (#14415)
* tests for components (WIP)

* finished adding tests to components

* added tests for providers

* add test command to doc tests

* fix imports

* exclude test files

* remove import

* add vitest as dev dependency

* fix build error

* ignore test files from eslint

* fix test from docs-ui
2025-12-30 13:19:57 +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
10dab3a47a docs: allow stop answer generation in AI assistant (#14387) 2025-12-23 08:58:16 +02:00
Shahed Nasser
662ec7430b docs: resolve example tag in DML properties (#14383) 2025-12-22 17:52:24 +02:00
Shahed Nasser
04a6343951 docs-utils: performance improvements for the clean OAS script (#14386) 2025-12-22 17:06:55 +02:00
Shahed Nasser
dc52dfd1dd docs: small fixes and improvements to text (#14385) 2025-12-22 17:06:25 +02:00
Shahed Nasser
b221e882d4 docs-utils: add operator map to docs generator knowledge base (#14382) 2025-12-22 14:41:01 +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
e07f22c4eb docs: add admin extensions to navbar (#14368) 2025-12-19 19:51:05 +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]
c97c600656 chore(docs): Generated DML JSON files (automated) (#14335)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-12-17 16:10:15 +02:00
github-actions[bot]
25bb8da9c8 chore(docs): Update version in documentation (automated) (#14334)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-12-17 15:50:23 +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
53cdbaa069 chore: generate and update OAS for translations (#14281)
* chore: generate and update OAS for translations

* support localization header

* add locale to all store routes

* fixes

* small fix
2025-12-16 15:52:33 +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
github-actions[bot]
fe314ab5bc chore(docs): Generated DML JSON files (automated) (#14284)
* chore(docs): Generated DML JSON files (automated)

* fixes

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-12-11 16:00:26 +02:00
Shahed Nasser
62c637d709 docs: updates for next release (#14275) 2025-12-11 15:56:34 +02:00
github-actions[bot]
920d002288 chore(docs): Update version in documentation (automated) (#14283)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-12-11 15:56:23 +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
github-actions[bot]
dcaf6d2c61 chore(docs): Update version in documentation (automated) (#14198)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2025-12-03 10:35:06 +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