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
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
368715ae37
docs: document when-then + migrations revert change ( #8089 )
...
- Add documentation around when-then and workflow conditions
- Change the CLI reference based on change in revert migrations command.
2024-07-11 12:30:50 +00: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
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
Shahed Nasser
273529fde5
docs: added chapter on managing relationships ( #8043 )
2024-07-09 18:12:00 +03: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
19c20ac747
docs: remove limitation on arrow functions in workflows ( #7958 )
2024-07-04 17:26:26 +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
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
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
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
