Commit Graph

239 Commits

Author SHA1 Message Date
Shahed Nasser
a2210ea5e7 docs: docs for next release (#14456) 2026-01-06 17:40:26 +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
b221e882d4 docs-utils: add operator map to docs generator knowledge base (#14382) 2025-12-22 14:41:01 +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
0084460765 docs: various improvements and fixes (#14257) 2025-12-09 16:16:45 +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
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
Shahed Nasser
c1ede88a7e docs: document locks for nested workflows (#14130)
* docs: document locks for nested workflows

* smal text change

* fix build error
2025-11-26 15:36:58 +02:00
Adrien de Peretti
beb91d88a2 chore(): Update glob package (#14083)
* chore(): Update glob package

* Create fresh-needles-wave.md
2025-11-19 21:53:32 +01:00
Dhanush Reddy
178b1e2b47 fix some typos (#14017)
Co-authored-by: William Bouchard <46496014+willbouch@users.noreply.github.com>
2025-11-14 15:54:28 +02:00
Shahed Nasser
9576ef3763 docs-utils: fix type error in react-docs-generator (#14002) 2025-11-07 12:02:56 +02:00
github-actions[bot]
423b6d94dc chore(docs): Updated UI Reference (automated) (#13968)
* chore(docs): Generated + Updated UI Reference (automated)

* fix react-docs-generator not resolving external types

* sort undefined

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-11-05 18:00:46 +02:00
github-actions[bot]
fffc1be1e7 chore(docs): Generated References (automated) (#13921)
* chore(docs): Generated References (automated)

* fix error + generate references

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-10-31 15:32:21 +02:00
Shahed Nasser
4ab185c685 docs: clarify how emitEventStep emits an event in a workflow (#13836) 2025-10-23 16:30:25 +03:00
Shahed Nasser
2ce0e37e98 docs-util: remove inferring of query parameters (#13834) 2025-10-23 14:15:59 +03:00
Shahed Nasser
356dcc94ce docs: avalara integration tutorial (#13808)
* docs: avalara integration tutorial

* fix getTaxLines method

* fixes

* fix broken link

* fix build error

* fix vale errors
2025-10-23 13:07:27 +03:00
Shahed Nasser
76f9da5ef4 docs: Caching Module (#13701)
* standard docs for caching module + deprecated cache module

* added guides for creating + using, and overall changes from cache to caching

* fix details related to redis provider

* fix build errors

* fix build error

* fixes

* add guides to sidebar

* add sidebar util

* document query + index

* moved cache tag conventions

* fix build errors

* added migration guide

* added memcached guide

* fixes

* general fixes and updates

* updated reference

* document medusa cache

* small fix

* fixes

* remove cloud cache

* revert edit dates changes

* revert edit dates

* small update
2025-10-21 10:34:27 +03:00
Shahed Nasser
26d497f285 docs: clarify how to use token in Auth Provider guide (#13759)
* docs: clarify how to use token in Auth Provider guide

* small fix
2025-10-16 08:27:42 +03:00
Shahed Nasser
9a5ca86b76 docs: support since, deprecated, and feature flag tags in dml reference (#13741) 2025-10-13 13:31:48 +03:00
Shahed Nasser
9f7df88c84 docs: add clarification for set cart's customer API route (#13506) 2025-09-15 14:32:36 +03:00
Shahed Nasser
d73591aafd docs: fix relations missing from data model reference diagrams (#13474) 2025-09-11 13:31:03 +03:00
Shahed Nasser
f1149ea170 docs: show the source code link in order models reference (#13398) 2025-09-03 10:36:59 +03:00
Shahed Nasser
7b1028e5ae docs-util: fix workflows not picked for some routes + generate OAS (#13342)
* generated oas

* fixes and improvements
2025-08-29 12:51:55 +03:00
Shahed Nasser
899ac2f052 docs: generate references for 2.10.1 (#13344) 2025-08-29 12:51:43 +03:00
Shahed Nasser
cf4da02e39 docs-util: fix error in release pipeline (#13343) 2025-08-29 12:51:32 +03:00
Shahed Nasser
69d22213f4 docs: add missing props to UI components (#13247) 2025-08-20 12:36:57 +03:00
Shahed Nasser
d1a1135328 docs: migrate UI docs (#13245)
* docs: create a new UI docs project (#13233)

* docs: create a new UI docs project

* fix installation errors

* docs: migrate UI docs content to new project (#13241)

* Fix content

* added examples for some components

* finish adding examples

* lint fix

* fix build errors

* delete empty files

* path fixes + refactor

* fix build error
2025-08-20 11:42:25 +03:00
Shahed Nasser
522fc12d7a docs: change from detecting version to since tag (#13127)
* update everything from version to since

* update events

* regenerate oas
2025-08-01 18:22:42 +03:00
Shahed Nasser
a48063ec26 docs: add link to manage metadata section in OAS and API reference (#13102) 2025-07-31 14:42:14 +03:00
Shahed Nasser
9bb4c0306b docs: fix to OAS generator following Zod update + generate API reference (#13030) 2025-07-24 14:36:28 +03:00
Shahed Nasser
b46bbfae12 docs: fix input type of some hooks in workflow reference (#12995) 2025-07-18 18:11:41 +03:00
Shahed Nasser
fc29fc66d2 chore: Fix freshness check script + update Linear SDK (#12991)
* chore: update Linear SDK in docs tools

* fix script

* use relative file path

* use relative file path
2025-07-18 15:56:02 +03:00
Shahed Nasser
a23bbc1cbb docs-util: throw when schema parsing fails (#12846) 2025-06-27 12:52:30 +03:00
Shahed Nasser
fcfd35a157 docs: sort events in reference alphabetically (#12845) 2025-06-27 11:56:36 +03:00
Shahed Nasser
2005188192 docs: fix step detection of useQueryGraphStep (#12842) 2025-06-26 19:02:27 +03:00
Shahed Nasser
7d95eb73d3 docs: update OAS for loyalty plugin (#12836)
* updates

* cleanup

* generate OAS

* update links
2025-06-26 17:22:18 +03:00
github-actions[bot]
7ac734ca21 chore(docs): Updated API Reference (automated) (#12826)
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>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-06-25 12:18:41 +00:00
Shahed Nasser
93cf79cb0f docs: add loyalty plugin routes to OAS (#12811)
* generated OAS

* remove unused schemas

* generated specs

* add cloud badge for routes

* add to loyalty plugin page

* allow clicking the tooltip
2025-06-24 19:17:55 +03:00
Shahed Nasser
8a88748982 docs: added cloud documentation project (#12711) 2025-06-12 11:29:14 +03:00
Shahed Nasser
009d00f27d docs: redesign table of content (#12647)
* implement toc

* added to projects

* fixes and adapt for references

* added product frontmatter

* remove action menu from 404 pages
2025-05-30 16:55:36 +03:00
Shahed Nasser
40e73c6ea2 docs: fix broken links utility + uncaught broken links (#12637)
* fix broken links

* update broken links utility

* add missing payment evens

* generate llms

* fix segment link
2025-05-28 17:13:27 +03:00
Shahed Nasser
fb6167eed2 docs: fix loading in order reference pages (#12629) 2025-05-28 10:42:13 +03:00
Shahed Nasser
8303aed701 docs: add support for ignoring hooks (#12599) 2025-05-23 18:48:08 +03:00
Shahed Nasser
04e0b43ed8 docs: document analytics module (#12563) 2025-05-22 15:05:04 +03:00
Shahed Nasser
61d3bdde4a docs-util: extract feature flags in generated OAS (#12554) 2025-05-21 14:25:40 +03:00
Shahed Nasser
bda143673d docs: show hooks in when condition in workflows reference (#12552) 2025-05-21 13:00:15 +03:00
Shahed Nasser
397d353af6 docs: fix timeout in order-related workflows reference (#12533) 2025-05-19 17:30:21 +03:00