asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
5,984 Commits 2 Branches 0 Tags
b37e976b9a43acb87c9e3234b540fabd2b391fc2
Commit Graph
100 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
Shahed Nasser b37e976b9a chore(core-flows): add TSDocs to the emitEventStep (#8413) 2024-08-05 13:20:22 +03:00
Shahed Nasser e7965db071 docs: added a chapter on how to emit an event (#8414) 2024-08-05 11:39:47 +03:00
Shahed Nasser bb4f002d0a docs: fix node version in create-medusa-app reference (#8443) 
* docs: fix node version in create-medusa-app reference

* change node version in cli reference
 2024-08-05 11:10:55 +03:00
Shahed Nasser 4d99cd5e28 docs: fix recipes sidebar + homepage cards (#8415) 2024-08-02 16:31:17 +03:00
Shahed Nasser 58b405fac9 docs: added digital product recipe example (#8223) 
- Added an example for the digital product recipe
- Fixes to the digital product recipe (overview)

Closes DOCS-792
 2024-08-02 13:02:06 +00:00
Shahed Nasser c4ff8c27f0 docs: added subscription recipe example (#8148) 
* docs: added subscription recipe

* fixed lint errors

* pass context and container to workflow

* rename context

* fix storefront customizations

* remove container from object

* updates based on latest changes

* fix workflow return

* general fixes
 2024-08-02 12:40:26 +03:00
Shahed Nasser 5ed5b45cce chore(utils, types): updated TSDocs of AbstractPaymentProvider (#8335) 
- Update the TSDocs of `AbstractPaymentProvider`
- Remove old TSDocs of `IPaymentProvider`
- Update the config that generates the payment module provider reference.

Closes DOCS-781
 2024-08-01 15:50:34 +00:00
Shahed Nasser 4a95a48e94 docs-util: mark type parameters as optional (#8320) 
Mark all type parameters in references as optional.

Closes DOCS-802
 2024-08-01 15:45:41 +00:00
Shahed Nasser 560b6c74a4 docs: add a documentation on calculating prices with taxes (#8330) 
Add a documentation page on how to calculate a product's prices with taxes in the Product Module's docs.

Closes DOCS-832
 2024-08-01 15:32:54 +00:00
Shahed Nasser 6fc2019534 chore(workflows-sdk): add TSDocs related to create-hook (#8380) 2024-08-01 09:57:14 +03:00
Shahed Nasser 22a629670b docs: add sidebar item for helper reference + examples fix (#8365) 2024-07-31 17:28:42 +03: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 fffd4f2b3b docs-util: support generating helper steps (#8354) 2024-07-30 19:06:16 +03:00
Shahed Nasser d4c9c1e7cd docs-util: fix how data model name is inferred (#8351) 2024-07-30 18:59:29 +03:00
Shahed Nasser 6fabb7fad2 docs: fix local link to infer slug from front matter (#8353) 2024-07-30 18:59:16 +03:00
Shahed Nasser 848d0892d9 chore(core-flows,modules-sdk): add TSDocs to helper steps (#8355) 2024-07-30 18:59:02 +03:00
Shahed Nasser 70d48a91b3 docs: added storefront guide on prices with taxes (#8326) 2024-07-30 12:52:21 +03:00
Shahed Nasser 4bd77174f0 docs-util: fix knowledge base for functions (#8337) 2024-07-30 12:52:08 +03:00
Shahed Nasser ebaf0eb53a docs-util: rename docblock-generator to docs-generator (#8331) 
* docs-util: rename docblock-generator to docs-generator

* change program name

* fix action
 2024-07-29 16:04:33 +03:00
Shahed Nasser 7ad4e7b1c9 docs: added typedoc plugin to parse DML json files (#8300) 
* docs-util: add docblock generator for models built with DML

* add missing turbo task

* docs-util: added typedoc plugin to parse dml json files
 2024-07-29 14:19:04 +02:00
Shahed Nasser f9d86683e5 docs-util: update knowledge base of docblock-generator (#8323) 
* docs: update knowledge base for functions and filters

* fix build error
 2024-07-29 12:34:25 +03:00
Shahed Nasser a171057fd7 chore(types): add a note about adding ssl_mode option to database URLs (#8324) 
* chore(types): add a note about adding `ssl_mode` option to database URLs

* small fix
 2024-07-29 12:34:10 +03:00
Shahed Nasser d127abbcda docs-util: add docblock generator for models built with DML (#8296) 
* docs-util: add docblock generator for models built with DML

* add missing turbo task
 2024-07-29 10:11:39 +02: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 f3274a7c5b docs: update deployment guides for storefront and admin (#8279) 
Update the vercel deployment guides for next.js storefront and admin

Closes DOCS-840 and DOCS-841
 2024-07-26 07:21:31 +00:00
Shahed Nasser 157fa3c80f docs: remove js client and medusa react references (#8270) 2024-07-26 10:11:37 +03:00
Shahed Nasser ebd290b531 docs: added guide on how to get product variant prices (#8282) 2024-07-26 10:09:41 +03:00
Shahed Nasser eb64ae75a6 docs: update middlewares to use defineMiddlewares (#8283) 2024-07-25 17:14:06 +02:00
Shahed Nasser 0c682b92c4 docs: updates to Medusa server deployment guides (#8268) 
* updated railway deployment docs

* general updates and fixes
 2024-07-25 09:55:22 +03:00
Shahed Nasser 6ed1181057 chore(types): update workerMode tsdocs (#8269) 2024-07-25 09:55:12 +03:00
Shahed Nasser 0a482e972f docs: added a section to introduction on using docs (#8257) 
Add a section to the introduction page explaining the different sections of the V2 docs and how / when to use them.
 2024-07-24 14:16:33 +00:00
Shahed Nasser b615645952 docs: fix package names of event bus modules (#8262) 
* docs: fix package names of event bus modules

* fix in config
 2024-07-24 17:07:41 +03:00
Shahed Nasser ccc99b48a0 docs: add 404 page (#8260) 2024-07-24 17:07:30 +03:00
Shahed Nasser 7a0941e997 docs: fix rewrites in sub-projects to prevent loop on 404 page (#8255) 2024-07-24 17:06:54 +03: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 a02f6cbca6 fix(types,order): fixes to order module's service and data models (#8247) 
* fix(types,order): fixes to order module's service and data models

* revert change for createLineItemAdjustments

* add missing context parameter
 2024-07-24 09:00:21 +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 55b55b6a92 docs: updates and fixes to marketplace recipe example (#8150) 
- Add compensation functions to workflows
- Use steps/workflows provided by Medusa instead of implementing the steps.
- Other fixes

PR in examples repo: https://github.com/medusajs/examples/pull/1 (might be easier to review)
 2024-07-23 07:10:05 +00: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 ac21f35b2c fix(create-medusa-app): run links sync during setup (#8215) 
Run `links sync` command along with running migrations
 2024-07-22 10:09:33 +00:00
Shahed Nasser f435c6c7f6 docs: fix fulfillment provider option name (#8211) 
Change `name` option of a fulfillment module provider to `id`.

Closes DOCS-830
 2024-07-22 07:17:15 +00: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 4ef268d829 fix(dashboard): fix header in create tax region form (#8197) 
Use correct text for the header of the create tax region form.

Closes TRI-40
 2024-07-19 13:19:02 +00:00
Shahed Nasser e0c0a86264 docs: added tax-inclusive conceptual guide and updates to storefront guide (#8186) 
* docs: added tax-inclusive conceptual guide and updates to storefront guide

* sentence fix

* currency_code -> country_code
 2024-07-18 19:03:37 +02:00
Shahed Nasser c900a104ce docs: fix auth routes in api reference (#8187) 2024-07-18 19:02:14 +02:00
Shahed Nasser 71ebcd1bd0 docs: fix module definition for providers (#8180) 2024-07-18 18:59:53 +02:00
Shahed Nasser 0dbb2c6691 docs: fix installation version of packages (#8177) 2024-07-18 13:04:29 +02:00
Shahed Nasser 76173afdfc docs: add update dependencies + release note details (#8159) 2024-07-18 08:57:11 +02:00
Shahed Nasser 0aac0f8bac docs: fix cross-project links to use base path in production (#8160) 2024-07-17 15:31:23 +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 4c004cd287 docs-util: add support for RequestWithContext in route-handler detection (#8141) 
* docs-util: update OAS docblock-generator to support RequestWithContext

* support alias type arguments in case there are no type arguments
 2024-07-16 13:06:19 +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 NasserandOli Juhl 5f2952bbf2 chore: fix docs issue template (#8068) 
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
 2024-07-14 18:04:11 +02:00
Shahed Nasser 85c15dbb25 fix(utils): error message when isQueryable is possibly not enabled. (#8096) 2024-07-11 18:54:43 +02:00
Shahed Nasser eebae37287 chore: add generated OAS and Typedoc output to automated PRs (#8054) 
* chore: add generated OAS output to automated PR

* add typedoc json output
 2024-07-11 18:17:37 +02:00
Shahed Nasser d8f58774df docs: highlight fixes (#8094) 2024-07-11 18:15:50 +02:00
Shahed Nasser 78f49286d0 docs: updated marketplace recipe + added example (#8061) 
- Moved recipes into its own section of the learning resources
- Updated the marketplace recipe overview
- Added an example implementation of the marketplace recipe

Closes DOCS-791
 2024-07-11 15:56:41 +00:00
Shahed Nasser 66acb3023e fix(migrations): small fix to the text (#8091) 
Small fix to  the migrations text.
 2024-07-11 13:16:11 +00: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 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
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
Shahed Nasser f1a860675c chore: update docs issue template (#8012) 
Update the documentation issues template to ask for the Medusa version.
 2024-07-08 09:02:57 +00:00
Shahed Nasser 3d6b1dc7ae docs: fix page crashing when using google translate (#8009) 2024-07-08 10:24:45 +02: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 eafa3560ae chore(dashboard): text changes and fixes (#7925) 
- Improvements to existing texts
- Add subtitles to sections where useful.
- Added the ability to edit the message shown in a list when no records are found + change the message where necessary
- Change documentation link to `https://docs.medusajs.com/v2`.
 2024-07-05 12:14: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
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 20be64e799 docs-util: normalize primary key types in DML (#7941) 2024-07-04 17:35:24 +03: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 9b1688944e fix: fix docs link in payment provider tsdocs (#7939) 
* fix: fix docs link in payment provider tsdocs

* add a note
 2024-07-04 11:09:29 +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
Shahed Nasser 5aa62e59e4 chore: fix generate preview references action (#7901) 2024-07-03 14:10:19 +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 9b5f26adab chore: action to generate documentation references (#7888) 
Added an action that triggers documentation actions generating references
 2024-07-01 13:54:17 +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 8fde57263f fix(create-medusa-app): remove preview links (#7884) 
Remove temporary doc links set in `STORE_CORS` and `ADMIN_CORS`
 2024-07-01 12:16:12 +00: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