Commit Graph
100 Commits
Author SHA1 Message Date
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
Shahed Nasser 9ded63cc62 chore: OAS and TSDoc fixes (#7864) 2024-07-01 10:21:34 +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 2833e3c4d0 fix(order): set correct change type for exchanges (#7870) 2024-07-01 10:20:58 +03:00
Shahed Nasser 6e65158af3 docs-util: Upgrade typedoc to 0.26 (#7853)
Upgrade typedoc to v0.26 + make changes based on the update

Note: This update produces an error when generating model references when the models use the `createPsqlIndexStatementHelper` decorator. As this isn't a breaking error, and as we'll move to DML in the future, it's not necessary to spend time on a fix.
2024-06-27 10:52:44 +00:00
Shahed Nasser 922fff4051 docs-util: fixes and improvements to OAS generator (#7731)
* fixed associated schema names

* move OAS method and summary descriptions to knowledge base

* refactoring and fixes

* detect default object value in delete responses
2024-06-26 11:54:09 +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 79d90fadc4 feat(utils): configure notification module by default (#7814)
Add the notification module to `defineConfig` and configure the local notification module.
2024-06-24 14:47:40 +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 7e7e6e3311 chore: fix OAS circular dependencies (#7693) 2024-06-12 19:42:03 +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 bd302e678e fix(medusa): return a single category instead of an array in retrieve category route (#7638)
* fix(medusa): return a single category instead of an array in retrieve category route

* change to use refetchEntity
2024-06-06 19:30:31 +02:00
Shahed Nasser 636bf3a15f fix(medusa-oas-cli): add circular dependency (#7639) 2024-06-06 20:26:11 +03:00
Shahed Nasser 6798bd9a0d docs-util: fix path to packages in mermaid plugin (#7640) 2024-06-06 20:25:34 +03:00
Shahed Nasser fa0c7dfbb5 fix(create-medusa-app): set the database host and port explicitely (#7637)
* pass host and port explicitely

* set AUTH_CORS in env
2024-06-06 18:26:06 +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 6646a203df chore(types, utils): add TSDocs for AbstractNotificationProviderService (#7556)
Add TSDocs for `AbstractNotificationProviderService` which will be used to generate a reference on how to create a notification provider module.
2024-06-04 13:36:06 +00:00
Shahed Nasser 1a1ef4f208 chore: fix generate docs pipelines (#7595) 2024-06-04 14:51:05 +03:00
Shahed Nasser c38f6d07c2 docs: update design + colors (#7593)
Update design and colors in docs to match those in Figma
2024-06-04 07:41:24 +00:00
Shahed Nasser 28d2a5347a chore(types, utils): added TSDocs for file provider module (#7553)
* chore(types, utils): added TSDocs for file provider module

* fix import
2024-06-03 10:18:02 +02: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 872c42c6dc chore(utils): added TSDocs to AbstractAuthModuleProvider (#7550)
Added TSDocs to AbstractAuthModuleProvider. These are used to generate the reference on how to create an auth provider module.
2024-06-03 07:41:09 +00:00
Shahed Nasser 6b86b1d531 chore(types): add TSDocs to the user module's types (#7549) 2024-05-30 18:04:44 +03:00
Shahed Nasser fe96bd39b1 docs: change config snippets to use defineConfig (#7546) 2024-05-30 16:47:28 +03:00
Shahed Nasser ddfd757277 fix(docs-util): recognize optional zod parameters (#7538)
* fix(docs-util): recognize optional zod parameters

* remove admin/auth as an authenticated route path
2024-05-30 16:47:16 +03:00
Shahed Nasser 11e3b9a456 chore: remove babel from eslint config (#7531) 2024-05-30 10:04:16 +03:00
Shahed Nasser 27b64c23f0 feat(create-medusa-app): support more environment variables + fixes (#7533) 2024-05-29 21:25:31 +02:00
Shahed Nasser 65ee18c5bc chore(modules-sdk): Small fix to error wording (#7526)
* chore(modules-sdk): Small fix to error wording

* rename variables

* fix tests

* rename plugins to providers in tests
2024-05-29 21:17:35 +02:00
Shahed Nasser c46c643fda chore: fix generate resources reference action (#7503) 2024-05-29 17:30:12 +03:00
Shahed Nasser 2c5ba408d4 docs: edits and fixes to commerce module docs (#7468)
Apply edits and fixes to the commerce modules docs
2024-05-29 11:08:06 +00:00
Shahed Nasser 130de74d6d docs: updates to admin customization docs (#7493)
* updated admin docs

* re-add navigation and parameters sections

* update injection zones

* update cli scripts docs

* added list of injection zones

* add details about widget props

* restructure admin injection zones
2024-05-29 13:50:19 +03:00
Shahed NasserandStevche Radevski 72b57e2ae4 docs: rename auth user to auth identity (#7400)
* docs: rename auth user to auth identity

* updated protected routes guide

* Update www/apps/resources/app/commerce-modules/auth/examples/page.mdx

Co-authored-by: Stevche Radevski <sradevski@live.com>

* store/me -> store/customers/me

* change scope to type

* remove soon notes

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
2024-05-29 13:47:11 +03:00
Shahed Nasser 8f97af0d91 docs: update config to be camel case (#7501) 2024-05-28 15:52:03 +03:00
Shahed Nasser 65be42c818 docs: add integrations page (#7421)
* add integrations page

* update payment provider docs

* use stripe icon
2024-05-28 13:25:03 +03:00
Shahed Nasser f8252b3d27 chore(medusa): pin @swc/core version to 1.5.7 (#7490) 2024-05-28 09:35:32 +02:00
Shahed Nasser 223b3978b2 docs: fix data payload of events in subscribers (#7406) 2024-05-28 09:24:40 +02:00
Shahed Nasser 7b059562d7 fix(core-flows): change default currency to eur (#7476) 2024-05-27 19:23:38 +03:00
Shahed Nasser 639758ffec chore(create-medusa-app): remove .github directory (#7473)
As we're adding some actions to the starter, it doesn't make sense to keep them in the cloned projects with `create-medusa-app`. This PR removes the `.github` directory from the project after cloning it
2024-05-27 12:43:49 +00:00
Shahed Nasser 98615c388b docs-util: fixes to base OAS + circular-patch redocly plugin (#7382)
* docs-util: remove MultipleErrors schema from base OAS

* fixes to circular patch plugin

* general fixes

* change nested schemas to references
2024-05-27 14:29:48 +02:00
Shahed Nasser b5b41c7a33 chore: remove duplicate package in changeset (#7472)
Remove `@medusajs/ui` from the preview changeset because it's added twice which causing an error in the release pipeline
2024-05-27 14:29:03 +02:00
Shahed Nasser 7390821da5 fix(link-modules): move readonly link to readonly directory (#7446) 2024-05-24 16:32:25 +03:00
Shahed Nasser 98808b6caa fix(link-modules): remove duplicate fulfillment set location link (#7441)
Remove the link defined in `location-fulfillment-set` because it's a duplicate of `fulfillment-set-location`.
2024-05-24 12:04:44 +00:00
Shahed Nasser bfa1dc27cb chore: add auth-emailpass package to changeset (#7437) 2024-05-24 07:02:14 +00:00
Shahed Nasser 9cbe0085d0 feat(create-medusa-app): remove admin email prompt (#7417)
* feat(create-medusa-app): remove admin email prompt

* change to constant
2024-05-23 12:23:45 +03:00
Shahed Nasser 6f1b90f207 fix(dashboard): fixes to strings (#7411)
* fix(dashboard): fix the text of manage areas

* add missing string

* add missing react import
2024-05-23 11:07:01 +03:00
Shahed Nasser bb5872de48 fix(dashboard): fix reservation's button text + documentation links (#7405)
* fix(dashboard): fix reservation's button text

* change documentation links
2024-05-22 18:39:19 +03:00
Shahed Nasser 5e0f98f578 fix(admin-sdk): error when admin needs build (#7401)
Fix the error shown when admin is not built instructing the user to run the `build` command.
2024-05-22 13:02:24 +00:00
Shahed Nasser 24a2ab754a fix(create-medusa-app): fix seed step to use seed script in package.json (#7397)
Fix the seed step to use the `seed` script defined in `package.json` to avoid issues if the file is renamed or path is changed
2024-05-22 11:41:45 +00:00
Shahed Nasser 6ab7cbd529 chore: fixes to ConfigModule's docblocks (#7390) 2024-05-22 13:40:53 +03:00
Shahed Nasser 6fa23a2695 feat(medusa): add error handling to exec script (#7394) 2024-05-22 12:39:34 +02: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 2187b82d5d fix(core-flows,types): general fixes to workflow types (#7392) 2024-05-22 11:27:12 +02:00