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
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
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
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
8c82207a41
docs: replace usages of migrations and links commands ( #8894 )
2024-08-30 11:48:49 +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
Shahed Nasser
48fe819d9e
docs: redesign vertical tabs ( #8673 )
2024-08-20 14:48:09 +02: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
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
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
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
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
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
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
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
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
fe96bd39b1
docs: change config snippets to use defineConfig ( #7546 )
2024-05-30 16:47:28 +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
728c5ee53c
docs: preparations for preview ( #7267 )
...
* configured base paths + added development banner
* fix typelist site url
* added navbar and sidebar badges
* configure algolia filters
* remove AI assistant
* remove unused imports
* change navbar text and badge
* lint fixes
* fix build error
* add to api reference rewrites
* fix build error
* fix build errors in user-guide
* fix feedback component
* add parent title to pagination
* added breadcrumbs component
* remove user-guide links
* resolve todos
* fix details about authentication
* change documentation title
* lint content
2024-05-13 11:32:52 +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
