Commit Graph

20 Commits

Author SHA1 Message Date
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 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 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 e9fce4c5c2 docs: improvements to intro and basics chapters (#8956) 2024-09-03 17:34:07 +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 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
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 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 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 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