Commit Graph

307 Commits

Author SHA1 Message Date
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
github-actions[bot]
86aeca0932 chore(docs): Generated References (#8072)
Generated the following references:
- `medusa`
- `modules`
- `order`
- `types`
2024-07-11 07:52:36 +00:00
Shahed Nasser
a8df528c65 docs: add a need help button (#8069)
* docs: add a need help button

* change github issue link

* responsive fixes
2024-07-11 10:29:13 +03:00
Shahed Nasser
d9b9a1df27 docs: add a section about constraints on step return value (#8036)
Rename the workflow constructor constraints document to include also step constraints and add a section about the allowed return value of a step.
2024-07-10 13:21:53 +00:00
github-actions[bot]
75e7047243 chore(docs): Generated References (automated) (#8052)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-10 09:36:11 +02:00
github-actions[bot]
7fa04aabce chore(docs): Generated API Reference (v2) (#8053)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-10 09:35:59 +02:00
github-actions[bot]
964f1f9dbe chore(docs): Generated References (automated) (#8026)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-07-09 19:03:13 +02: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
3e4a96a31c docs: update order module's conceptual guides (#7893)
* fixes + add return document

* update order conceptual guides

* resolve todo

* re-generate files map
2024-07-09 18:14:30 +03:00
Shahed Nasser
273529fde5 docs: added chapter on managing relationships (#8043) 2024-07-09 18:12:00 +03:00
Shahed Nasser
4c89f91caf docs: fix download button + other fixes (#8032)
- Fix text of download button
- Small fix to styling on small devies
- Fix mobile sidebar items using incorrect base url
2024-07-09 12:36:02 +00:00
Shahed Nasser
04886ea122 docs: rename property when defining a list link (#8017)
* docs: rename property when defining a list link

* added note about static directory

* remove note about static directory
2024-07-08 19:30:46 +02:00
Shahed Nasser
0c8730cdd3 docs: fix type in module path (#8011) 2024-07-08 18:15:29 +02:00
github-actions[bot]
d7d26aa3f4 chore(docs): Generated References (#7998)
Generated the following references:
- `medusa_config`
- `modules`
- `types`
2024-07-08 08:48:39 +00:00
github-actions[bot]
6c7a0129e3 chore(docs): Updated API Reference (v2) (#7999)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
2024-07-08 08:47:26 +00:00
Adil
1c6d1c28ff docs : Fix wrong model names in marketplace recipe (#8002)
- Replaced `store_user` that have been copy/paste with the right ones
2024-07-08 11:28:08 +03:00
Shahed Nasser
d2c89e7071 fix(create-medusa-app): remove glob-related warnings (#7985)
On every new installation of `create-medusa-app`, you get a warning related to `glob`'s version.

Since we don't need `glob` anymore (it was used to remove boilerplate files), I've removed it along with its usage. This includes removing the `--no-boilerplate` option.
2024-07-08 08:24:10 +00:00
Shahed Nasser
de0a9c14ab docs: fix pagination on mobile devices (#7968)
* docs: fix pagination on mobile devices

* fix algolia link
2024-07-05 12:40:42 +02:00
Shahed Nasser
36c1db7479 docs: fix edit button on resources homepage (#7967) 2024-07-05 10:52:43 +02:00
github-actions[bot]
1162b1625d chore(docs): Generated API Reference (v2) (#7962)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-05 09:55:55 +02:00
github-actions[bot]
ca9ba9e688 chore(docs): Generated References (automated) (#7961)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-07-05 09:55:39 +02:00
Shahed Nasser
22dbe34625 docs: fix URL of Algolia cron job (#7957) 2024-07-04 17:32:41 +00:00
Shahed Nasser
19c20ac747 docs: remove limitation on arrow functions in workflows (#7958) 2024-07-04 17:26:26 +00:00
Shahed Nasser
92dd855290 docs: restructure api-reference to allow base path (#7954) 2024-07-04 16:12:02 +00:00
Shahed Nasser
94e5feeb3d docs: fix rewrite to main docs (#7953) 2024-07-04 17:29:30 +02:00
Shahed Nasser
1acbcf612e docs: fix api-reference with proxy (#7952) 2024-07-04 17:10:48 +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
a8f2115157 docs: update pricing docs (#7895)
Update pricing docs following latest changes
2024-07-01 16:34:13 +00:00
Shahed Nasser
dd864da4e0 generate references (#7882) 2024-07-01 16:02:36 +03:00
Shahed Nasser
b9036eca1a docs: generate OAS for v2 (#7883) 2024-07-01 15:35:45 +03:00
Shahed Nasser
1f360a3245 docs-util: support models implemented with DML in typedoc custom plugins (#7847)
- Support generating reference for models implemented with DML
- Support resolving and generating mermaid diagram for relations

The Currency Module was used an example so its reference is generated to showcase the work of this PR.
2024-07-01 07:34:51 +00:00
Shahed Nasser
b62f23ea00 docs: additions and improvements to modules and DML documentation (#7854)
* docs: additions and improvements to modules and DML documentation

* small wording fix
2024-07-01 10:26:40 +03:00
Shahed Nasser
72f7500c84 chore(docs): DML API Reference (#7863)
* added dml options

* added tsdocs + configurations
2024-07-01 10:21: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
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
Adrien de Peretti
48963f55ef Chore/rm main entity concept (#7709)
**What**
Update the `MedusaService` class, factory and types to remove the concept of main modules. The idea being that all method will be explicitly named and suffixes to represent the object you are trying to manipulate.
This pr also includes various fixes in different modules

Co-authored-by: Stevche Radevski <4820812+sradevski@users.noreply.github.com>
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-06-19 13:02:16 +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
85d487d90b docs: added checkout storefront guides (#7678)
* add first guides

* added more guides

* finished payment + added stripe

* finished adding guides

* updated generated sidebar
2024-06-12 19:46:06 +02:00
Shahed Nasser
ee6bdd0ab0 docs: add products storefront guides (#7645)
* add tips + regions pages

* docs: added storefront regions guide

* removed storefront tips chapter from book

* added product guides

* finished price guide

* add product category pages

* more categories pages

* finished category pages

* add collections guides

* add missing next.js comment

* use useRegion hook

* added missing link
2024-06-11 19:55:56 +02:00
Shahed Nasser
f3bf8c73a3 docs: added cart storefront guides (#7662)
* docs: added cart storefront guides

* add context guides

* small fixes to the context
2024-06-11 11:56:37 +03:00
Shahed Nasser
2597990363 docs: fix details of selecting fields and relationships in api reference (#7642) 2024-06-09 15:19:51 +02:00
Shahed Nasser
46c5c5fe28 docs: added storefront regions guides (#7623) 2024-06-09 15:19:09 +02:00
Shahed Nasser
6946814944 docs: update recipes to be based on v2 (#7516) 2024-06-09 15:18:43 +02:00
Shahed Nasser
e472aed00f docs: new + improved auth documentation pages (#7529)
* added and improved auth docs

* add prep to generates resources action

* add module options to sidebar

* fix broken link
2024-06-09 15:18:29 +02: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