Shahed Nasser
6e856d3156
docs: added examples page ( #9587 )
...
- Added an examples page with examples of all different concepts in Medusa. We'll probably add more examples with time as we see the need for them.
- Small fixes in different pages.
Preview: https://resources-docs-ocb5uyp0o-medusajs.vercel.app/v2/resources/examples
2024-10-16 10:07:39 +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
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
74b286b701
docs: added documentation for admin components ( #9491 )
...
- Documented common admin components with design that matches the admin.
- Updated existing admin customization snippets to match the admin's design.
Closes DOCS-964
2024-10-14 07:18:38 +00:00
Shahed Nasser
e3dc9eaf0c
docs: add guide on how to seed data ( #9449 )
...
Add a guide on how to seed data using a custom CLI script, with an example to seed products
Closes DOCS-953
2024-10-14 07:08:05 +00:00
Shahed Nasser
f3c8f5efef
docs: document using conditional operators in workflows ( #9464 )
2024-10-07 17:52: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
fb67d90b64
docs: improvements + additions to module docs ( #9152 )
...
- Split Module and Module Links to their own chapters
- Add new docs on db operations and transactions in modules, multiple services, links with custom columns, etc...
- Added a list of registered dependencies in a module container
2024-10-01 11:20:54 +00:00
Shahed Nasser
1ad7e7583f
docs: fix imports from dist ( #9401 )
2024-10-01 09:49:37 +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
b3a204e974
docs: document InferTypeOf ( #9321 )
...
- Add documentation on how to use InferTypeOf
- Use InferTypeOf in recipes and examples
2024-09-26 13:42:29 +00:00
Shahed Nasser
39a6780815
docs: add note about authentication opt out ( #9298 )
...
Closes #9268
2024-09-26 13:04:27 +00:00
Shahed Nasser
ea2cc974cc
docs: fixes to customization docs ( #9236 )
...
Closes #9225 , #9224 , #9226 , #9227
Closes DOCS-948, DOCS-947, DOCS-945, DOCS-946
2024-09-26 13:00:37 +00:00
Shahed Nasser
2da15ba021
docs: added architecture documentation ( #9256 )
...
* docs: added architecture documentation
* update diagrams and text
* address PR comments
* sidebar + overview fixes
2024-09-26 09:29:47 +03:00
Shahed Nasser
6584e911e0
docs: improvements + additions to workflow docs ( #9182 )
...
Improve existing workflow docs + add missing docs
2024-09-20 15:38:32 +00:00
Shahed Nasser
bf4335f2a6
docs: improvements and fixes to API route docs ( #9197 )
...
General improvements and fixes to docs around API routes
2024-09-19 14:08:23 +00:00
Shahed Nasser
58f06be44d
docs: update docs across projects following publishable API key change in store routes ( #9098 )
...
* docs: update docs across projects following publishable API key change in store routes
* rename env variable
* move subscribe route out of store
2024-09-16 16:42:08 +03:00
Shahed Nasser
0bcdcccbe2
docs: update query usage across docs ( #9120 )
...
WIP
2024-09-16 12:46:26 +00:00
Shahed Nasser
8584031041
docs: replace ModuleRegistrationName with Modules ( #9142 )
2024-09-16 15:30:03 +03:00
Shahed Nasser
41fb2aacb0
docs: fixes to long-running workflows + relationship docs ( #9101 )
2024-09-12 09:51:00 +03:00
Shahed Nasser
1466ca73e0
docs: added a services constraint document ( #8999 )
...
- Added a services constraint document mentioning that a service's methods must be async.
- Modify the code in the services intro document to use `async` method.
2024-09-10 18:00:23 +00:00
Shahed Nasser
e9b5f76f9a
docs: add Query documentation ( #9079 )
...
- Replace remote query documentation with new Query documentation
- Add redirect from old remote query to new query documentation
- Update remote query usages across docs to use new query usage.
2024-09-10 12:31:47 +00:00
Shahed Nasser
b5dbf572e3
docs: document star actor types ( #9044 )
2024-09-06 17:38:51 +02:00
Shahed Nasser
abe7b66999
docs: rename admin-shared -> admin-sdk ( #9008 )
2024-09-06 10:33:34 +02:00
Shahed Nasser
1d54e8fdc1
docs: add new API route guides + fixes and improvements to existing ones ( #8987 )
...
- Add new documentation pages for API route intro, responses, errors, and validation
- General fixes and improvements across existing API route guides
> Note: I didn't work on the guide for additional data validation. Will work on this as part of my next focus on workflows.
2024-09-04 18:23:55 +00:00
Shahed Nasser
46a70eaf5b
docs: added a section on middlewares and trailing backslashes ( #8942 )
2024-09-03 17:32:36 +03:00
Attila Turcsan
b9eac4402b
Update page.mdx ( #8908 )
...
Fix API route path in the example.
2024-08-30 13:11:32 +00:00
Shahed Nasser
8c82207a41
docs: replace usages of migrations and links commands ( #8894 )
2024-08-30 11:48:49 +03:00
Shahed Nasser
59217a9796
docs: add a note about the middleware regular expression ( #8742 )
2024-08-27 10:35:43 +02:00
Shahed Nasser
5996089c9c
docs: added new guides and troubleshooting related to admin development ( #8739 )
2024-08-27 10:35:09 +02: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
64283d0e83
docs: redesign API runner ( #8688 )
...
* fix up block style + plain theme color
* initial redesign
* docs: redesign API Runner
* revert yarn.lock changes
2024-08-21 17:48:16 +03:00
Shahed Nasser
48fe819d9e
docs: redesign vertical tabs ( #8673 )
2024-08-20 14:48:09 +02:00
Shahed Nasser
73905c14b1
docs: redesign notes ( #8661 )
...
* docs: redesign notes
* fix color for warning notes
* allow optional links
* show links in a note
* allow line code in notes
2024-08-20 14:47:24 +02:00
Shahed Nasser
45f9961d19
docs: remove link to events reference ( #8669 )
2024-08-20 12:32:04 +02:00
Shahed Nasser
198d7c9927
docs: add a section in the book on how to retrieve a relationship ( #8594 )
2024-08-15 16:30:00 +03:00
Shahed Nasser
705ea0ad33
docs: improve the workflow hooks guide ( #8538 )
...
* initial
* docs: improve workflow hook guides
2024-08-13 09:55:37 +03:00
Shahed Nasser
decd830474
docs: added a note about admin customizations as arrow functions ( #8387 )
2024-08-06 09:44:22 +02:00
Shahed Nasser
8eb538ff8f
docs: added a section on sending requests to api routes in admin ( #8412 )
2024-08-05 13:20:34 +03:00
Shahed Nasser
e7965db071
docs: added a chapter on how to emit an event ( #8414 )
2024-08-05 11:39:47 +03:00
Viktor Bakurin
ec0a68ec88
docs: fix helloWorldLoader function definition ( #8429 )
...
- Make helloWorldLoader async to follow the type definition
Closes #8428
2024-08-05 07:23:49 +00:00
Shahed Nasser
6f973d9f2b
docs: added workflow hooks docs + changed workflow response ( #8364 )
...
* docs: added workflow hooks docs + changed workflow response
* Update page.mdx
2024-07-31 17:01:33 +03:00
Shahed Nasser
a4eab3f37a
docs: added a service factory reference ( #8292 )
...
Added a service factory reference of the generated methods and how to use them.
Since the types in the codebase are a bit complex, a generated reference won't provide a valuable result.
Instead, this reference is created manually and aims to cover common use cases, providing examples for them.
Closes DOCS-844
2024-07-26 14:40:56 +00:00
Shahed Nasser
eb64ae75a6
docs: update middlewares to use defineMiddlewares ( #8283 )
2024-07-25 17:14:06 +02:00
Shahed Nasser
774d04da48
docs: fix information related to link directions ( #8236 )
...
* docs: fix keys passed to remoteLink.create and remoteLink.dismiss
* updated hello module name + clarified note
* added details about module link directions
* fix lint errors
2024-07-24 09:16:01 +02:00
Shahed Nasser
97f64a5cfe
docs: fix note about how method names are generated ( #8240 )
...
* docs: fix note about how method names are generated
* small fix
2024-07-23 18:28:34 +03:00
Shahed Nasser
a2d08eb635
docs: document links sync command ( #8212 )
...
* docs: document links sync command
* small wording fix
* sentence fix
2024-07-22 13:17:53 +03:00
Shahed Nasser
5def252e4b
docs: add section on delete cascades ( #8198 )
...
* docs: add section on delete cascades
* small text fix
2024-07-21 21:21:36 +02:00
Shahed Nasser
2f56030101
docs: remove the requirement on is queryable ( #8199 )
2024-07-21 21:20:24 +02:00
Shahed Nasser
8daa4119f0
docs: add chapter on executing a workflow in another / in a step ( #8163 )
...
* docs: added chapter on using workflow in another
* remove container from object
* change to only mention executing a workflow in another
* pass missing highlight
2024-07-21 21:19:23 +02:00