Commit Graph

166 Commits

Author SHA1 Message Date
Shahed Nasser
cd66cdd2bb docs: generate OAS manually for 2.7.0 (#12158)
* original changes

* changes

* fixes for delete operations

* generate oas
2025-04-11 16:41:39 +03:00
Shahed Nasser
fde85888bd docs-util: handle workflows with intersection hook types (#12099) 2025-04-07 14:00:08 +03:00
Shahed Nasser
82d774b395 docs-util: add a prefix for JS SDK examples in OAS (#11989) 2025-03-26 13:28:23 +02:00
Shahed Nasser
178e034561 docs-util: sort examples to show JS SDK first (#11986) 2025-03-25 19:25:34 +02:00
Shahed Nasser
83e063229b docs-utils: support routes that include global variables (#11976)
* docs-util: support urls that have variable names

* re-generate examples

* disable removing js sdk examples and replace with warning
2025-03-25 15:36:00 +02:00
Shahed Nasser
8a302130b3 docs-util: add JS SDK examples to generated OAS (#11935) 2025-03-25 11:11:48 +02:00
Shahed Nasser
df5ae50612 docs-util: add tool to generate mapping between JS SDK examples and routes (#11933)
* initial implementation

* finish implementation

* add js sdk key
2025-03-21 15:34:52 +02:00
Shahed Nasser
eb2aa8da3c docs-util: collapse types in references (#11888)
* docs-util: collapse types in references

* improve for arrays
2025-03-18 16:49:34 +02:00
Shahed Nasser
cb68a9e67b docs: added how-to guides for architectural modules (#11883)
* added initial how-tos

* finished changes

* generated sidebars
2025-03-18 09:49:19 +02:00
Shahed Nasser
28b0d08591 docs: add documentation for Locking Module (#11824)
* add locking docs

* fix main navbar

* added implementation example links

* generate refs

* update architecture

* fix vale error
2025-03-13 12:20:24 +02:00
Shahed Nasser
ac989a6ed1 moved configurations page 2025-03-11 10:59:29 +02:00
Shahed Nasser
87b041800a fixes + added new sidebars 2025-03-10 08:33:21 +02:00
Shahed Nasser
08ce70a368 docs-util: add exceptions for routes with custom auth middleware (#11755) 2025-03-06 13:05:50 +02:00
Shahed Nasser
e81deb49f8 docs-util: fix freshness check script (#11737)
* docs-util: fix freshness check script

* Update freshness-check.ts
2025-03-05 13:35:28 +02:00
Shahed Nasser
0eadcdd555 docs: updates to tax provider and other provider guides (#11626) 2025-02-26 16:13:05 +02:00
Shahed Nasser
731f118987 docs: fix types for provider docs not generated correctly (#11598) 2025-02-25 14:31:26 +02:00
Shahed Nasser
be566ca6fb docs: fix OAS generator + generate OAS (#11584) 2025-02-24 15:30:38 +02:00
Shahed Nasser
1077993aaa chore: improvements to provider docs (#11451) 2025-02-13 18:11:39 +02:00
Shahed Nasser
49bf934da3 docs-util: fix inline code escape in generated references (#11428) 2025-02-12 19:08:37 +02:00
Shahed Nasser
5c44811cb0 docs: document module providers in plugins (#11360)
* docs: document module providers in plugins

* small fixes

* add missing title
2025-02-07 14:17:14 +02:00
Shahed Nasser
ccb332ce41 docs: fix empty return in references (#11343) 2025-02-06 14:35:45 +02:00
Shahed Nasser
386ce4b857 docs: fix incorrect hook details shown (#11225) 2025-01-30 12:40:14 +02:00
Shahed Nasser
dd487f02e1 docs-util: fix issue with creating StoreProductType OAS schema (#11180) 2025-01-27 17:33:46 +02:00
Shahed Nasser
4ccb489dbe docs: generate references manually for 2.4.0 (#11171) 2025-01-27 17:00:42 +02:00
Shahed Nasser
97280cd928 docs-util: fix incorrect workflow extracted in OAS (#11120) 2025-01-23 19:21:16 +02:00
Shahed Nasser
0d18d5854a docs: fixes for core workflows reference (#11056)
* docs: fix step input / output description not showing

* fix generated example for array types

* show workflow summary in diagram

* fix workflow node width

* hide undefined types
2025-01-20 17:34:02 +02:00
Shahed Nasser
d089852ce3 docs: improve content of workflows reference overview page (#11045) 2025-01-20 10:54:32 +02:00
Shahed Nasser
044af3f211 docs-util: add exception for workflow examples modification + show summary instead of comment (#10963)
* docs-util: add exception for workflow examples modification + show summary instead of comment

* add currency and country code in example

* add common IDs
2025-01-14 18:47:56 +02:00
Shahed Nasser
98e77fad89 docs-util: reorder workflow execution examples (#10955)
* docs-util: reorder workflow execution examples

* reorder again

* add examples header
2025-01-14 11:52:50 +02:00
Shahed Nasser
2a2b387bc3 docs: add additional data description in generated references (#10944) 2025-01-13 20:47:37 +02:00
Shahed Nasser
1b86c17b72 docs-util: remove duplicate union children (#10942) 2025-01-13 19:48:51 +02:00
Shahed Nasser
2a9ca1d1e1 docs: fixes to workflow reference tooling (#10931) 2025-01-13 13:35:04 +02:00
Shahed Nasser
c5915451b8 docs-util: add examples generator for workflows and steps (#10914)
* initial changes

* docs-util: generate examples for workflows and steps
2025-01-10 19:16:43 +02:00
Shahed Nasser
a126f40bbe docs: DX improvements to a workflow / step reference page (#10906) 2025-01-10 13:47:08 +02:00
Shahed Nasser
a607b8e800 docs-util: fix hook input type showing as __type (#10905) 2025-01-10 10:25:17 +02:00
Shahed Nasser
bd73716bb6 docs-util: add warning on request body change (#10881) 2025-01-08 21:40:46 +02:00
Shahed Nasser
46f987e351 docs-util: fix parsing when function if it has three parameters (#10878)
* docs-util: fix parsing when step when it has three parameters

* fix condition
2025-01-08 16:48:20 +02:00
Shahed Nasser
60fd1cbc6c docs: document dependencies for auth provider (#10865)
* docs: document dependencies for auth provider

* fixes

* document overriding callback url
2025-01-07 16:42:45 +02:00
Shahed Nasser
edcff0ed16 docs-util: fixes to OAS generator + generate OAS (#10867) 2025-01-07 16:35:55 +02:00
Shahed Nasser
1c355dac36 docs: update and fix UI props docs (#10754) 2024-12-27 14:53:46 +02:00
Shahed Nasser
91ebf6d61c docs-util: add publishable api key header parameter to store routes OAS (#10747)
* docs-util: add publishable api key header parameter to store routes OAS

* fix oas
2024-12-26 16:27:55 +02:00
Shahed Nasser
ce51c36ecf chore: improve payment provider tsdocs + generate reference (#10742) 2024-12-26 14:11:52 +02:00
Shahed Nasser
ee50e67a96 docs: add JS SDK to commerce modules sidebars (#10740) 2024-12-26 13:33:33 +02:00
Shahed Nasser
97baa56d71 docs: add workflow / step tags (#10731) 2024-12-25 11:04:55 +02:00
Shahed Nasser
9a05888538 docs-util: fix query params not retrieved correctly for some routes (#10708) 2024-12-23 17:43:28 +02:00
Shahed Nasser
c804ae575b docs-util: fix links in references to current page (#10703) 2024-12-23 16:27:01 +02:00
Shahed Nasser
870cb6e88c docs: update typedoc, convert packages to esm, generate references (#10699) 2024-12-23 15:20:09 +02:00
Shahed Nasser
0f5d640736 docs: generate references manually for v2.1.2 (#10639)
* docs: manually generate references for v2.1.2

* more changes
2024-12-17 19:20:44 +02:00
Shahed Nasser
ee62083c52 docs-util: infer resolved resources in workflow + steps (#10637) 2024-12-17 19:03:00 +02:00
Shahed Nasser
2a73d0ac0d docs-util: support @tags comments (#10627)
* support tags in tsdocs + add them in frontmatter

* fixes
2024-12-17 13:07:59 +02:00