Commit Graph

128 Commits

Author SHA1 Message Date
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
Shahed Nasser
03803283d6 chore: fix docs freshness check action (#10592) 2024-12-13 09:40:59 +02:00
Shahed Nasser
54118941ef docs-util: support @version tag (#10591) 2024-12-13 09:40:47 +02:00
Shahed Nasser
c3b2b4b438 chore: fixes to tsdocs + docs-util related to providers 2024-12-11 17:27:32 +02:00
Shahed Nasser
376b9e85bc docs: regenerate references for core flows (#10538) 2024-12-10 19:28:35 +02:00
Shahed Nasser
ab1bfb966d docs: generate references manually for 2.1.1 (#10534)
* docs: generate references manually for 2.1.1

* re-generate for core-flows

* Revert "re-generate for core-flows"

This reverts commit ff785c80214dc6125e2da4c6e8a674a87b03e9dd.
2024-12-10 18:49:30 +02:00
Shahed Nasser
482929f74d docs: fix page title in reference pagesnot showing + refactor workflows reference (#10537)
* docs: fix references title + refactor workflow reference generation

* update references sidebar
2024-12-10 18:19:03 +02:00
Shahed Nasser
3409953c4f docs: use tooling convention across docs (#10512) 2024-12-09 19:15:29 +02:00
Shahed Nasser
866cabf384 docs-util: normalize RelationNullableModifier in model references (#10505) 2024-12-09 15:11:45 +02:00
Shahed Nasser
8dedb97e40 docs: fix links to steps in workflow references (#10503) 2024-12-09 14:55:35 +02:00
Shahed Nasser
abdd4c9e99 docs-util: support new query type argument (#10468)
* add support for second query argument

* more fixes
2024-12-06 12:21:19 +02:00
Shahed Nasser
582f52b31d docs-util: add user, pricing, and auth as modules with DML (#10423) 2024-12-04 12:54:19 +02:00
Shahed Nasser
030b0cc095 docs: generate references manually (#10325)
* docs: generate references

* prep changes
2024-11-27 19:27:25 +02:00
Shahed Nasser
9b76d2a2d0 docs-util: fix build errors (#10275) 2024-11-25 19:38:29 +02:00
Shahed Nasser
5eccd4e87d docs: fix references generator (#10271) 2024-11-25 19:13:21 +02:00
github-actions[bot]
7865909891 chore(docs): Updated API Reference (automated) (#10258)
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>
2024-11-25 14:33:22 +00:00
Shahed Nasser
dbd06a131a docs-util: remove duplicate methods from JS SDK (#10161) 2024-11-19 18:07:44 +02:00
Shahed Nasser
c054f47872 docs-utils: make reference table of content in alphabetical order (#10084) 2024-11-13 18:10:20 +02:00
Shahed Nasser
5fec006371 docs-util: fix helper step settings (#10045) 2024-11-13 11:01:14 +02:00
Shahed Nasser
e10fb34eb9 docs: fix slugs pointing to admin rather than store routes (#10063) 2024-11-13 10:42:58 +02:00
Shahed Nasser
e229bea3c1 docs: fix resolve of custom file module guide (#9840)
Closes #9833
2024-11-10 07:33:07 +00:00
Shahed Nasser
04cec64fa1 docs: show latest version in docs + update automatically (#9753) 2024-10-24 14:03:34 +03:00
github-actions[bot]
f997432e73 chore(docs): Updated API Reference (automated) (#9728)
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>
2024-10-24 09:42:32 +00:00
github-actions[bot]
5deeae060a chore(docs): Generated References (automated) (#9727)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:41:14 +00:00
Shahed Nasser
a1190b7208 docs: generate + configure js sdk reference (#9714)
Manually generate the JS SDK reference + add it to the sidebar
2024-10-22 17:31:32 +00:00
Shahed Nasser
34621f53a3 docs-util: fixes to package renames + other options (#9671) 2024-10-21 09:53:47 +03:00
Shahed Nasser
b07dd33a57 docs-util: add configuration to generate js-sdk reference (#9630) 2024-10-17 19:32:21 +03:00
Shahed Nasser
ea5bff9034 docs: update providers to use ModuleProvider (#9579)
Document change introduced by #9544

> Note: fine to merge now as it requires generating references, which will only happen after the next release.
2024-10-16 11:37:14 +00:00
Shahed Nasser
eed88c95ec docs: improved commerce modules [5/5] (#9592)
- Improve remaining commerce modules
- Other: add a note about using methods of the modules' main services.
2024-10-16 10:25:21 +00:00
Shahed Nasser
2b77bd85a6 docs-util: fixes for OAS docs generator + framework typedoc config (#9603)
* fix order replaced in OAS response + framework tsdoc config

* fix for some types
2024-10-16 12:17:28 +03:00
Shahed Nasser
714b9e6c98 docs: update resolve path to use src (#9605)
Update path used in `resolve` of modules to start with `src`
2024-10-16 09:10:30 +00:00
Shahed Nasser
6efb5897dc docs: fix package names in module registration (#9590)
* docs: fix package names in module registration

* update references
2024-10-16 09:05:07 +02:00
Shahed Nasser
b6df24463d docs: updates for breaking changes (#9558)
- Update modules registration
- Update `medusa-config.js` to `medusa-config.ts`
- Update the out directory in the admin deployment guide
- Update logger imports
- Other fixes

Note: will need to re-generate references afterwards

Closes #9548
2024-10-14 10:40:30 +00:00
Shahed Nasser
dd162d69be docs-util: fix import in generated workflow hook snippet (#9499) 2024-10-11 17:17:02 +02:00
Shahed Nasser
bc8de8e5b1 docs: add section on testing providers (#9453) 2024-10-04 10:29:45 +03:00
Shahed Nasser
5fb9c1f82e chore(oas): general fixes to OAS (#9413)
General fixes to OAS
2024-10-02 15:21:40 +00: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
1e144e9c08 chore(oas): clean up oas (#9354)
* clean up generated oas

* fix issues in docs-util

* more fixes

* align max level

* validation fix

* add missing summaries

* fix validation

* fix exchanges route
2024-10-02 10:27:02 +03: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