Damien Thiesson
adb3a8246a
docs: fix import path in the workflow basic documentation ( #9481 )
...
The import is three levels up, but, the `src/api/workflow/route.ts` file is only two levels down from `src/workflow`.
2024-10-07 07:22:15 +00:00
Shahed Nasser
ed174826a4
docs: update modules chapter in basics ( #9452 )
...
* docs: update modules chapter in basics
* address PR feedback
2024-10-04 14:15:41 +03: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
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
Mohmmed Aqeeb
3320f13f5a
Fix: Correct module path and clarify config structure in Medusa v2 Docs ( #9222 )
...
### What
This PR addresses an issue in the Medusa v2 documentation regarding the module creation example. The import paths were corrected to reflect the proper directory structure, ensuring clarity for users.
Closes #9220
### Why
The previous documentation contained incorrect import paths that could lead to confusion for users attempting to create and configure modules. Clarifying the structure aims to prevent similar issues for future users.
### How
- Updated the import statements in the documentation to go two levels up instead of three.
- Added clarification in the `medusa-config.js` example to indicate that the `modules` node should be a part of `projectConfig`.
### Testing
While documentation changes do not require formal testing, I reviewed the updated paths and descriptions against the current code structure to ensure accuracy and clarity.
### Note
This is my first contribution to an open source project, and I'm excited to contribute to the Medusa community!
2024-09-23 13:55:32 +00: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
8584031041
docs: replace ModuleRegistrationName with Modules ( #9142 )
2024-09-16 15:30:03 +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
4b663a4559
docs: document events reference ( #9080 )
...
- Remove old hidden reference files that document modules' events
- Add new events reference for workflow events
- Reference events reference in the main docs
2024-09-10 12:20:09 +00:00
Shahed Nasser
abe7b66999
docs: rename admin-shared -> admin-sdk ( #9008 )
2024-09-06 10:33:34 +02:00
Shahed Nasser
e9fce4c5c2
docs: improvements to intro and basics chapters ( #8956 )
2024-09-03 17:34:07 +03:00
Shahed Nasser
8c82207a41
docs: replace usages of migrations and links commands ( #8894 )
2024-08-30 11:48:49 +03:00
Ray Quijada
bb0fcbad7b
docs(ui): update 3.4 Modules & Services v2 documentation ( #8751 )
...
* chore: update 3.4 Modules and Services v2 documentation
explicitly mentioned `service.ts` requirement in 3.4 guide from 3.6
Content from:
https://docs.medusajs.com/v2/basics/modules-directory-structure#servicets
* chore: add missing dot
---------
Co-authored-by: Shahed Nasser <shahednasser@gmail.com >
2024-08-26 10:53:52 +03: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
Viktor Bakurin
be8afcaa63
docs: fix ModuleRegistrationName import ( #8434 )
...
Closes #8433
2024-08-05 07:24:27 +00: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
b1964a0384
docs: remove type arguments passed to createWorkflow ( #8161 )
2024-07-17 13:19:51 +01:00
Shahed Nasser
f73ca97ecc
docs: rename data to event in subscribers across docs ( #8149 )
2024-07-16 17:12:05 +01:00
Shahed Nasser
b38c0488be
docs: remove imports from src in medusa-config.js ( #8132 )
...
Importing from `src` in `medusa-config.js` works in development, but would cause an error when running `build`/in production.
This removes from the docs all snippets that imports from the `src` directory. However, we should figure out a better way to handle re-using the module's name.
2024-07-15 16:00:54 +00:00
Shahed Nasser
a74c900ab1
docs: add documentation for migration generate cli tool ( #8128 )
...
* docs: add documentation for migration generate cli tool
* changed migrations details in marketplace recipe
* added generated oas files to action
* vale + lint fixes
* don't import from src in medusa-config.js
* fix generate command in recipe
* fix module name
2024-07-15 17:46:10 +02:00
Shahed Nasser
d8f58774df
docs: highlight fixes ( #8094 )
2024-07-11 18:15:50 +02:00
Shahed Nasser
bb0303cd6a
docs: improvements to module and data model documentation ( #8062 )
...
* docs: improvements to module and data model documentation
* add note about data model name casing
2024-07-11 13:53:40 +03:00
Shahed Nasser
02add3f0f5
docs: change event payload handling in subscribers ( #8078 )
2024-07-11 13:34:24 +03:00
Mostafa Al Mohammad
f441663224
docs: fix typo in curl command example ( #8071 )
...
## Documentation Typo Fix: curl Command for Testing Service
This pull request addresses a typo in the documentation for testing the service via curl command on the page: [https://docs.medusajs.com/v2/basics/modules-and-services ](https://docs.medusajs.com/v2/basics/modules-and-services )
**Initial Command (incorrect):**
```
curl http://locahost:9000/store/custom
```
**Corrected Command:**
```
curl http://localhost:9000/store/custom
```
The typo involved a missing "l" in "localhost". This fix ensures users can successfully test the service by providing the correct curl command.
2024-07-11 07:53:09 +00:00
Shahed Nasser
0c8730cdd3
docs: fix type in module path ( #8011 )
2024-07-08 18:15:29 +02:00
Shahed Nasser
525363630e
docs: latest fixes ( #7951 )
2024-07-04 16:28:41 +02: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
0aeba83a66
docs: update scheduled jobs docs ( #7905 )
...
- Update scheduled jobs docs to support updated definition + remove coming soon notice
- Update scheduled jobs everywhere else they're used.
2024-07-02 09:41:15 +00:00
Shahed Nasser
6cb28eedf7
docs: document composite indices + primary key changes ( #7902 )
2024-07-02 12:34:44 +03:00
Shahed Nasser
0462cc5acf
docs: updates to use DML and other changes ( #7834 )
...
- Change existing data model guides and add new ones for DML
- Change module's docs around service factory + remove guides that are now necessary
- Hide/remove all mentions of module relationships, or label them as coming soon.
- Change all data model creation snippets to use DML
- use `property` instead of `field` when referring to a data model's properties.
- Fix all snippets in commerce module guides to use new method suffix (no more main model methods)
- Rework recipes, removing/hiding a lot of sections as a lot of recipes are incomplete with the current state of DML.
### Other changes
- Highlight fixes in some guides
- Remove feature flags guide
- Fix code block styles when there are no line numbers.
### Upcoming changes in other PRs
- Re-generate commerce module references (for the updates in the method names)
- Ensure that the data model references are generated correctly for models using DML.
- (probably at a very later point) revisit recipes
2024-06-26 07:55:59 +00: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
70e1de7742
docs: change module paths in resolve ( #7539 )
...
Change the path to modules in the resolve property across docs
2024-06-03 07:41:30 +00:00
Shahed Nasser
fe96bd39b1
docs: change config snippets to use defineConfig ( #7546 )
2024-05-30 16:47:28 +03:00
Shahed Nasser
130de74d6d
docs: updates to admin customization docs ( #7493 )
...
* updated admin docs
* re-add navigation and parameters sections
* update injection zones
* update cli scripts docs
* added list of injection zones
* add details about widget props
* restructure admin injection zones
2024-05-29 13:50:19 +03:00
Shahed Nasser
8f97af0d91
docs: update config to be camel case ( #7501 )
2024-05-28 15:52: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
9b1998b9b2
docs: update events reference ( #7321 )
...
* change subscribers events
* add event references for modules
2024-05-16 09:01:12 +02:00
Shahed Nasser
327e446974
docs: general fixes and overall changes ( #7258 )
...
* editing halfway
* edited second half
* adjust starter steps
* fix build
* typo fix
2024-05-07 18:00:28 +02: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
