Commit Graph

715 Commits

Author SHA1 Message Date
Shahed Nasser 7b2879d643 chore(docs): Fix docblock-generator OAS tool's max-stack error (#7246)
* regenerate oas to fix duplicate keys

* fix clean:oas script

* fix max-stack errors

* fix max-level condition
2024-05-06 13:41:59 +03:00
Shahed Nasser b39de05535 chore: move docs-util to www (#7232)
* reorganize docs apps

* add README

* fix directory

* add condition for old docs

* move docs-util to www

* remove remaining docs-util

* fixes of paths

* fix scripts

* path fixes

* fix github actions

* add build packages script
2024-05-06 09:13:50 +03:00
Shahed Nasser 4fe28f5a95 chore: reorganize docs apps (#7228)
* reorganize docs apps

* add README

* fix directory

* add condition for old docs
2024-05-03 17:36:38 +03:00
github-actions[bot] 8f776489a3 chore(docs): Generated Docs Announcement Bar (automated) (#7212)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-05-02 18:38:28 +02:00
Shahed Nasser b6083ce104 docs: added documentation for toast component changes (#7141)
* docs: added documentation for toast component changes

* added redirect from use-toast docs to upgrade guide

* remove unused file

* content linting fixes

* update UI package version

* updated ui preset

* fix upgrade guides main page
2024-05-01 18:12:10 +03:00
github-actions[bot] f43e8b3e73 chore(docs): Generated Docs Announcement Bar (automated) (#7190)
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>
2024-05-01 10:15:35 +00:00
eskoniarek dca47f77c9 docs: fix for subscriber logic in digital products recipe (#7184)
Update the subscriber code snippet in Digital Product recipe, to properly wait for the pre-signed URL for each item's media.

Closes [#7170 ](https://github.com/medusajs/medusa/issues/7170)
2024-05-01 07:35:52 +00:00
Dan Vaynshteyn 342712b8ab Fixed logged-in-user.mdx example (#7132)
Previous documentation stuffed type imports with regular imports. This was fine, but either remove the unnecessary 'type' in the first import statement or import like this PR.
2024-04-26 08:05:52 +00:00
Shahed Nasser abf1283ab6 docs: add details about the new host option of admin (#7142) 2024-04-24 18:01:11 +02:00
adil 3ee29f0878 fix-docs: TS error when importing a function as a type only (example logged in user middleware) (#7073) 2024-04-23 07:49:09 +00:00
Shahed Nasser 7934fbdd1e docs: fix download button in API reference (#7039)
* docs: fix download button in API reference

* remove comments
2024-04-15 09:37:24 +02:00
Shahed Nasser ed0313adef docs: change supabase database url format (#7036) 2024-04-15 09:35:58 +02:00
Shahed Nasser 0c12d7e7d7 docs: add note about expanding nested relations (#7008) 2024-04-15 09:32:57 +02:00
Shahed Nasser 8958760d5b docs: fixes to Digital Product recipe (#7025) 2024-04-15 09:32:07 +02:00
Shahed Nasser 8b388b815b docs: add a section about missing migration name (#7013) 2024-04-15 09:31:24 +02:00
Shahed Nasser 793184bf42 docs: improvements to railway deployment guide + new troubleshooting guide (#7012) 2024-04-15 09:30:31 +02:00
Omar Hawwash 9ca38eba04 docs: Update fulfillment.AbstractFulfillmentService.mdx (#6936) 2024-04-04 09:36:16 +00:00
github-actions[bot] 62752c70c8 chore(docs): Removed Docs Announcement Bar (automated) (#6915)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-04-03 07:12:17 +00:00
github-actions[bot] 7fe164bc1d chore(docs): Generated References (#6904)
Generated the following references:
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax_calculation`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-04-02 10:06:06 +00:00
github-actions[bot] 85e5478873 chore(docs): Updated API Reference (#6831)
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-04-02 09:47:04 +00:00
Raiyan Sarker 9d466717f4 docs(plugin): paypal integration missing createOrder callback (#6401)
This PR adds missing information in paypal plugin docs which is crucial to its use. Previously, docs didn't mention about createOrder callback that is required by PayPal sdk to connect with backend for details like currency and amount to be charged. Medusa backend responds with required id for the PayPal sdk to use. Related to https://github.com/medusajs/nextjs-starter-medusa/issues/260#issuecomment-1944157985

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-04-02 08:10:35 +00:00
github-actions[bot] 68aa0971a2 chore(docs): Generated References (#6896)
Generated the following references:
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `payment`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax_calculation`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-04-01 13:35:12 +00:00
Shahed Nasser 412111e1ea chore: fix doc announcement actions (#6856)
- Fix error in doc announcement actions due to missing build step.
- Update the announcement in the docs to the latest version
2024-03-28 17:23:25 +00:00
github-actions[bot] 8e3e49fbbf chore(docs): Generated API Reference (#6755)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-03-27 18:24:22 +01:00
Shahed Nasser 16860cc883 docs: added doc pages for v1.20.4 (#6828)
- Added new documentation page for Medusa Worker.
- Updated Railway deployment guide with details on Medusa Worker.
- Small adjustments to the `worker_mode` option's TSDocs.
2024-03-26 19:19:57 +00:00
Shahed Nasser e005987adf fix(medusa-oas-cli): fix tool not working in Medusa backends (#6812)
* fix(medusa-oas-cli): fix tool not working in custom projects

* fix changeset message

---------

Co-authored-by: Riqwan Thamir <rmthamir@gmail.com>
2024-03-26 09:33:06 +02:00
github-actions[bot] d24c819e7d chore(docs): Updated UI Reference (#6754)
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>
2024-03-22 15:26:11 +00:00
Deveosys 8929b2d60b Update example-logged-in-user.mdx (#6780)
Add authenticate() middleware to be able to get current user with req.user
2024-03-22 08:44:13 +00:00
Oli Juhl a859b7895e docs: Upgrade guide for v1.20.3 (#6753) 2024-03-20 11:12:53 +00:00
Shahed Nasser bb87db8342 docs: prep for v2 documentation (#6710)
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).

_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._

## Changes

- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
2024-03-18 07:47:35 +00:00
Shahed Nasser d38b5eb790 docs: fix migrations path in extend entity docs (#6645) 2024-03-11 08:44:53 +01:00
Minh Tu Ngo 7109969874 docs: Heroku typo (#6629) 2024-03-08 17:01:30 +00:00
Shahed Nasser 531e9e1e94 docs: hide admin translations contribution page (#6603) 2024-03-06 21:25:33 +01:00
Shahed Nasser 82db53c99e docs: fix search in api reference (#6578)
* docs: fix search in api reference

* remove log messages
2024-03-05 10:02:56 +01:00
Shahed Nasser 860d56041a docs: fixes to CLI reference (#6530) 2024-02-29 13:37:36 +01:00
Leonardo Cabeza be8122bc0d Update redis.md (#6519)
Fix ioredis options url
2024-02-27 08:45:34 +00:00
Shahed Nasser 3b18f399c1 docs(ui): show icon tooltip on small devices (#6407) 2024-02-26 08:31:36 +01:00
Shahed Nasser 52afc619b3 docs: typo fix in create event module reference (#6470) 2024-02-22 12:16:18 +01:00
Shahed Nasser c3e30224c7 docs: add missing widget props for collections injection zones (#6452)
* docs: add missing widget props for collections injection zones

Adds missing widget props for the `product_collection.details.before` and `product_collection.details.after` injection zones.

* fix lint error
2024-02-21 07:49:30 +01:00
Shahed Nasser 68123c6ffd docs: add missing steps to enable medusa_v2 flag (#6406) 2024-02-16 14:20:52 +00:00
Shahed Nasser 0d68eadf84 docs: add ignore tag to isPaymentProcessor (#6410)
- Add ignore tags to `isPaymentProcessor` method and property
- Generate payment reference to move the associated section.
2024-02-16 12:51:14 +00:00
Leonardo Cabeza 811a004c03 fix: typo in git checkout command (#6403)
typo in a git command
2024-02-15 08:34:09 +00:00
Shahed Nasser 16927469eb docs: fixes to code snippets in Workflows documentation (#6393) 2024-02-14 13:25:35 +00:00
Shahed Nasser d1f697c88e docs: new troubleshooting guide + cors fix (#6387)
- Fixed CORS middleware to account for routes of a single path (for example, `/custom` and not just `/custom/test`).
- Added a troubleshooting guide for admin webpack errors (see issue #6375)
2024-02-13 11:32:02 +00:00
github-actions[bot] 869dc751a0 chore(docs): Updated UI Reference (#6347)
* chore(docs): Generated UI Reference

* fixed props typing + added new alert page

* updated ui dependencies

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-02-12 19:46:51 +01:00
Shahed Nasser bc2a63782b docs: update next.js starter docs (#6378)
* docs: update next.js starter docs

* added empty changeset
2024-02-12 14:10:08 +01:00
Nicklas Gellner 2afcf1c918 docs: clarification in text (#6361)
changed from payment to fulfillment provider in the text
2024-02-12 08:20:07 +00:00
github-actions[bot] 1d0a978ffe chore(docs): Generated References (#6351)
Generated the following references:
- `file`
- `fulfillment`
- `inventory`
- `js_client`
- `medusa`
- `medusa_config`
- `medusa_react`
- `modules`
- `notification`
- `payment`
- `price_selection`
- `pricing`
- `product`
- `services`
- `stock_location`
- `tax`
- `tax_calculation`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-02-08 21:18:10 +00:00
github-actions[bot] e56c440911 chore(docs): Generated API Reference (#6346)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-02-08 22:05:15 +01:00
github-actions[bot] 3fcf109011 chore(docs): Generated Docs Announcement Bar (automated) (#6345)
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>
2024-02-08 17:10:33 +00:00