Commit Graph

52 Commits

Author SHA1 Message Date
Shahed Nasser
2ec59ddadc docs: typos and examples fixes (#11954)
* docs: typos and examples fixes

* fix notification example
2025-03-24 09:33:22 +02:00
Shahed Nasser
2b2b65f5f7 docs: cache revalidation in next.js storefront + storefront totals (#11887)
* initial changes

* generated sidebar
2025-03-18 12:20:09 +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
bc3d04dac9 docs: read-only links + other changes (#11878)
* docs: read-only links + other changes

* re-generate

* fix vale errors
2025-03-18 08:31:09 +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
87b041800a fixes + added new sidebars 2025-03-10 08:33:21 +02:00
Shahed Nasser
95eef899f7 docs: add notes + missing links for user guide (#11621)
* docs: add notes + missing links for user guide

* fix build errors

* fixes
2025-02-26 15:28:18 +02:00
Shahed Nasser
dc3a4b5c40 docs: add troubleshooting for cloudflare s3 (#11143) 2025-01-24 18:51:43 +02:00
Shahed Nasser
a0e944a7a8 docs: general fixes and additions (#10876) 2025-01-08 16:09:48 +02:00
Ehtisham Afzal
2734dd6f20 docs: added Cloudflare R2 guide for Object Storage (#10497)
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2025-01-08 08:06:50 +00:00
Shahed Nasser
9acd0f72a6 docs: revise architectural modules documentation 2024-12-11 12:36:16 +02:00
Shahed Nasser
3409953c4f docs: use tooling convention across docs (#10512) 2024-12-09 19:15:29 +02:00
Shahed Nasser
a429a267f1 docs: add Sanity integration guide (#10152)
* docs: add integrate to Sanity guide

* address PR feedback

* added more screenshots

* edit introduction

* added meta images + changes
2024-11-20 16:17:33 +02:00
Jim Johnston
18a60e2d2e docs: S3 providers - add example for DigitalOcean Spaces endpoint (#10145)
The [S3 providers docs](https://docs.medusajs.com/resources/architectural-modules/file/s3#:R1d5rtttqj5db:) instructs DigitalOcean users to set the endpoint address to the "Spaces Origin Endpoint":
```
For DigitalOcean Spaces, it's the Spaces Origin Endpoint.
```

On DigitalOcean's user interface they include the bucket name in their origin endpoint:
![image](https://github.com/user-attachments/assets/e4c6ab05-ff1c-40ad-bb2b-49653b990e6b)

Using this url for the endpoint will cause an error.

The example URL `https://{region}.digitaloceanspaces.com` should tip users off to remove the bucketname.

Cheers!
2024-11-19 10:52:26 +00:00
Shahed Nasser
938f3bd934 docs: update to next 15 + eslint 9 (#9839)
* update next

* updated react

* update eslint

* finish updating eslint

* fix content lint errors

* fix docs test

* fix vale action

* fix installation errors
2024-11-13 17:03:17 +02:00
Shahed Nasser
1fbe1d4ee9 docs: update event module guide (#10056) 2024-11-13 11:00:22 +02:00
Shahed Nasser
731309e87a docs: fixes following QA testing (#9690) 2024-10-22 18:20:21 +03:00
Shahed Nasser
61e6a07b55 docs: rename packages (#9618) 2024-10-18 14:43:46 +00: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
00a51b59b1 docs: update imports of middlewares and http types (#9440) 2024-10-03 15:56:58 +00: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
Shahed Nasser
8d3fb7fb2b docs: use require instead of import in medusa-config.js (#9102)
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
2024-09-16 19:34:00 +02:00
Shahed Nasser
8584031041 docs: replace ModuleRegistrationName with Modules (#9142) 2024-09-16 15:30:03 +03:00
Shahed Nasser
a28c911c24 docs: update auth docs + add new storefront guides (#9020)
* docs: update auth docs + add new storefront guides

* lint content

* fix vale error

* add callback response schema

* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* Update www/apps/resources/app/commerce-modules/auth/authentication-route/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* address PR comments

* replace google -> github

* better explanation for refresh token

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
2024-09-06 15:26:10 +03:00
Shahed Nasser
70f2290a22 docs: added documentation for db commands (#8846)
* docs: added documentation for db commands

* fix lint errors
2024-08-29 10:46:00 +03:00
420coupe
a430339d54 feat(notification-sendgrid): include ability to handle attachments (#8729)
* feat(notification-sendgrid): include ability to handle attachments array if passed to dynamicTemplateData.attachments

* docs: update sendgrid page.mdx

include attachments documentation in example

* ability to set from email, must be verified sender

* docs: update to include optional from property

* first-class optional vars for from & attachments

* docs: update for optional first-class vars

* Update www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-08-28 09:39:41 +03:00
420coupe
aa1ef20172 docs: update to include Supabase S3 File Provider (#8715)
update to include instructions for Supabase S3 Storage

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-08-23 11:10:58 +00:00
Shahed Nasser
b23f0f8188 docs: change notes across docs based on redesign (#8662)
Change the prerequisites / soon / other notes based on latest redesign

Depends on #8661
2024-08-23 07:59:48 +00:00
Shahed Nasser
810debc7bb docs: add a note about installing preview version (#8648)
- Add a note about ensuring a package's version is set to `preview` in `package.json`
- Add a troubleshooting guide for deployments with a section about preview versions
- Added a troubleshooting section to the railway deployment guide about preview versions

Closes #8646
Closes DOCS-913
2024-08-22 08:33:24 +00:00
Shahed Nasser
b8ba020cd5 docs: redesign tables (#8653)
* docs: redesign tables

* fixes
2024-08-20 14:47:36 +02:00
Shahed Nasser
caf1bfd23b docs: fixes to notification and file module guides (#8451) 2024-08-06 09:59:46 +03:00
420coupe
a392b2be0c Update page.mdx (#8425)
corrected example to use createNotifications vs create
2024-08-05 07:21:11 +00:00
Shahed Nasser
b615645952 docs: fix package names of event bus modules (#8262)
* docs: fix package names of event bus modules

* fix in config
2024-07-24 17:07:41 +03:00
Shahed Nasser
0dbb2c6691 docs: fix installation version of packages (#8177) 2024-07-18 13:04:29 +02:00
Shahed Nasser
f73ca97ecc docs: rename data to event in subscribers across docs (#8149) 2024-07-16 17:12:05 +01:00
Shahed Nasser
02add3f0f5 docs: change event payload handling in subscribers (#8078) 2024-07-11 13:34:24 +03:00
Shahed Nasser
5c44ce6640 docs: updates to local file module provider documentation (#8030)
Updates to the local file provider module's documentation based on latest changes
2024-07-09 15:25:05 +00:00
Shahed Nasser
964927b597 docs: general fixes and improvements (#7918)
* docs improvements and changes

* updated module definition

* modules + dml changes

* fix build

* fix vale error

* fix lint errors

* fixes to stripe docs

* fix condition

* fix condition

* fix module defintion

* fix checkout

* disable UI action

* change oas preview action

* flatten provider module options

* fix lint errors

* add module link docs

* pr comments fixes

* fix vale error

* change node engine version

* links -> linkable

* add note about database name

* small fixes

* link fixes

* fix response code in api reference

* added migrations step
2024-07-04 17:26:03 +03:00
Shahed Nasser
6713d76db3 docs: prepare configuration (#7877)
* update configuration

* resolve todos + remove events guides

* disable v2 docs in v1 navbar

* remove v2 from v1 mobile sidebar

* resolve build errors

* fix build errors

* fix lint errors

* fix lint
2024-07-03 19:27:13 +03:00
Carlos R. L. Rodrigues
a7844efd09 chore: move ModuleRegistrationName to utils (#7911) 2024-07-03 06:30:56 -03:00
Shahed Nasser
1842cd33cf docs: rename provider module to module provider (#7869)
* docs: rename provider module to module provider

* fix vale rule

* vale fixes
2024-07-01 10:21:19 +03:00
Shahed Nasser
c1db40b564 docs: added customer storefront guides (#7685)
* added customer guides

* fixes to sidebar

* remove old customer registration guide

* fix build error

* generate files

* run linter
2024-06-13 12:21:54 +03:00
Shahed Nasser
4a6327e497 docs: make code blocks collapsible (#7606)
* added collapsible code feature

* fixed side shadow

* fix build errors

* change design

* make code blocks collapsible
2024-06-05 10:28:41 +03:00
Shahed Nasser
fe96bd39b1 docs: change config snippets to use defineConfig (#7546) 2024-05-30 16:47:28 +03:00
Shahed Nasser
65be42c818 docs: add integrations page (#7421)
* add integrations page

* update payment provider docs

* use stripe icon
2024-05-28 13:25:03 +03:00
Shahed Nasser
154673f3d8 docs: fixes and changes based on latest updates (#7322)
* docs: changes based on DX changes

* remove fields no longer needed

* remove unnecessary parameters

* fixes to authenticate middleware usage

* add highlight to migrations config

* change configuration to http

* added missing remote link docs

* fix name in sidebar

* added notification module docs + updated file module docs

* add vale exceptions

* fix vale errors

* added docs on custom cli scripts
2024-05-22 13:37:48 +03:00
Shahed Nasser
7cb90f8e82 docs: editing and general fixes of medusa's learning resources (#7261)
* docs: editing and general fixes of medusa's learning resources

* fix build script

* update ui dependency

* fix build

* adjust next.js steps
2024-05-13 18:55:11 +03:00
Shahed Nasser
803e4aad02 docs: added file module docs (#7278) 2024-05-13 18:54:59 +03:00