Commit Graph
100 Commits
Author SHA1 Message Date
Shahed Nasser bbc47dc5df docs: fix missing hooks property (#10008) 2024-11-12 09:53:12 +01:00
Shahed Nasser 713e428ec2 docs: fix cart completion in subscriptions recipe (#10021) 2024-11-11 20:37:26 +02:00
Shahed Nasser a131a4468d docs: improve getting started chapters (#10014) 2024-11-11 20:35:57 +02:00
Shahed Nasser 5e1ccba06d docs: fix link to testing tools (#10030) 2024-11-11 18:24:55 +00:00
Shahed Nasser c4183a5cb7 docs: improve transform docs (#10023) 2024-11-11 19:21:53 +01:00
Shahed Nasser 0ef92cce28 chore(medusa): show success message after user is created (#10027) 2024-11-11 20:16:14 +02:00
Shahed Nasser 94fb420434 docs: fix server worker mode in railway deployment (#9842)
* docs: fix server worker mode in railway deployment

* fix DISABLE_MEDUSA_ADMIN
2024-11-11 09:44:21 +01:00
Shahed Nasser 5d7c1ad655 docs: add more context and description to recipe steps (#9861) 2024-11-10 22:43:42 +01:00
Shahed Nasser e94f35458c docs: add instructions on how to roll back a migration (#9870) 2024-11-10 22:43:31 +01:00
Shahed Nasser c7b24eb3ec docs: remove upgrade guides doc (#9845) 2024-11-10 14:13:00 +01:00
Shahed Nasser 6e775a2e04 chore: update doc links in README (#9860) 2024-11-10 08:58:19 +01:00
Shahed Nasser e229bea3c1 docs: fix resolve of custom file module guide (#9840)
Closes #9833
2024-11-10 07:33:07 +00:00
Shahed Nasser d0d9bbcca9 docs: add common redirects to v1 docs (#9832)
Add common redirects to v1 docs that don't affect v2 docs
2024-11-10 07:32:44 +00:00
Shahed Nasser 37eeaa84a2 docs: small improvement to first customization guide (#9843)
Added a bit more context and what you'll build in the first customization guide and why it's powerful.

Closes DX-1044
2024-11-06 09:09:35 +00:00
Shahed Nasser 4d7cb54762 docs: add a note in 404 page about v1 docs (#9815) 2024-10-28 14:42:22 +01:00
Shahed Nasser 43a44cf426 chore(js-sdk,types): add tsdocs for admin JS SDK methods [4/n] (#9745)
Add TSDocs to admin JS SDK from notification to payment

[4/n]
2024-10-28 04:42:17 +00:00
Shahed Nasser df5dc65e2a docs: added documentation on environment variables (#9798) 2024-10-26 14:35:38 +00:00
Shahed Nasser f40ea9cfbf chore(js-sdk,types): add tsdocs for admin JS SDK methods [5/n] (#9788)
* chore(js-sdk,types): add tsdocs for admin JS SDK methods [5/n]

* add api route link
2024-10-25 13:02:17 +03:00
Shahed Nasser fd26839616 docs: fixes to ui docs (#9759) 2024-10-25 11:56:54 +03:00
Shahed Nasser bf18d73ff4 docs: fix complete cart workflow usage in marketplace recipe (#9771)
- Fix usage of `completeCartWorkflow` which now returns an ID instead of the full order
- other: improvements in config across projects
2024-10-25 08:53:42 +00:00
Shahed Nasser 92bbd7953b chore: update links to v2 docs in source code and comments (#9732) 2024-10-24 15:18:38 +03:00
Shahed Nasser 6617f81640 docs: add ui rewrite (#9762) 2024-10-24 14:02:55 +02:00
Shahed Nasser 88f2d17a24 docs: change configurations to make v2 the main docs (#9729)
* docs: change configurations to make v2 the main docs

* move api routes to top level

* remove api prefix

* update opengraph images

* show v1 link

* add redirect to v1
2024-10-24 14:49:58 +03:00
Shahed Nasser 5a1b6f0810 docs: fix deleteCascade typo (#9744) 2024-10-24 14:03:46 +03:00
Shahed Nasser 04cec64fa1 docs: show latest version in docs + update automatically (#9753) 2024-10-24 14:03:34 +03:00
Shahed NasserandHarminder Virk 669adbcdc9 fix(js-sdk): remove list and retrieve methods of paymentCollection (#9746)
Co-authored-by: Harminder Virk <virk.officials@gmail.com>
2024-10-24 12:27:57 +02:00
Shahed Nasser c08df5ac44 docs: remove dev notices + fix AI assistant answer width (#9686)
* docs: remove dev notices + fix AI assistant answer width

* fix import

* more notes removal

* rc to latest
2024-10-23 09:52:52 +02:00
Shahed Nasser 8891c0a3d0 docs: remove v1 docs from navbar (#9722)
* docs: remove v1 docs from navbar

* remove fallback
2024-10-23 09:10:27 +02:00
Shahed Nasser f7932f11ed docs: fix details on setting / updating customer ID in cart (#9689) 2024-10-22 20:40:39 +03:00
Shahed Nasser a1190b7208 docs: generate + configure js sdk reference (#9714)
Manually generate the JS SDK reference + add it to the sidebar
2024-10-22 17:31:32 +00:00
Shahed Nasser af3c6b0d93 chore: update release actions related to docs and starter (#9713)
* chore: update release actions related to docs and starter

* change name
2024-10-22 18:44:20 +03:00
Shahed Nasser 3c0f0e2259 docs: small text fix (#9684) 2024-10-22 18:20:35 +03:00
Shahed Nasser 731309e87a docs: fixes following QA testing (#9690) 2024-10-22 18:20:21 +03:00
Shahed Nasser b2122c4073 docs: fixes and refactoring for API reference (#9708)
* docs: fixes and refactoring for API reference

* add route caching

* remove caching

* use next cache
2024-10-22 18:20:06 +03:00
Shahed Nasser 7b147aa651 docs: update nav items (#9709) 2024-10-22 18:08:45 +03:00
Shahed Nasser 14efb2a420 chore(js-sdk,types): add tsdocs for admin JS SDK methods [3/n] (#9712) 2024-10-22 18:08:33 +03:00
Shahed Nasser 3df7ebe3d1 chore(js-sdk,types): add tsdocs for admin JS SDK methods [2/n] (#9696)
Add TSDocs to admin JS SDK from customer groups to fulfillment providers

[2/n]
2024-10-22 11:53:09 +00:00
Shahed Nasser 5ea3100c10 chore(js-sdk,types): add tsdocs for admin JS SDK methods [1/n] (#9667)
Add TSDocs to admin JS SDK from API keys to currencies

[1/n]
2024-10-22 11:19:04 +00:00
Shahed Nasser a0668adefa fix(dashboard,js-sdk): remove methods / hooks to non existing exchange routes (#9697)
Remove the following exchange methods (and hooks from dashboard) which point to routes that don't exist:

- `delete`
- `addItems`
- `updateItem`
- `removeItem`
2024-10-21 14:00:30 +00:00
Shahed Nasser fa15db4538 chore(types,js-sdk,medusa): Add TSDocs for store and auth's JS SDK + small type fixes (#9657)
* added jsdocs

* more tsdocs

* added for cart completion

* finish up the store tsdocs
2024-10-21 11:03:33 +03:00
Shahed Nasser b4855825be docs: fix scroll + divider issues (#9663) 2024-10-21 09:54:05 +03:00
Shahed Nasser 34621f53a3 docs-util: fixes to package renames + other options (#9671) 2024-10-21 09:53:47 +03:00
Shahed Nasser 4829b16e6f chore: fix to DML action (#9672) 2024-10-21 09:52:29 +03:00
Shahed Nasser 2ea766daf5 fix(dashboard,js-sdk): remove method and hook for deleting claim (#9668) 2024-10-18 19:43:53 +03:00
Shahed Nasser 61e6a07b55 docs: rename packages (#9618) 2024-10-18 14:43:46 +00:00
Shahed Nasser 30659b077a chore(utils): update tsdocs for provider identifiers (#9656) 2024-10-18 17:32:15 +03:00
Shahed Nasser 85865c18ff docs: document JS SDK installation (#9611)
- Add a page introducing JS SDK + how to install and use it (generally)
- Adjust admin tips on how to send requests
- Adjust storefront tips to mention JS SDK
- Add in the API reference intro how to install JS SDK
- Other related additions / changes

Closes DX-957
2024-10-18 12:47:40 +00:00
Shahed Nasser 0a37675f0e docs: add routing page (#9550)
- Add a new homepage to `book` project for the routing page
- Move all main doc pages to be under `/v2/learn` (and added redirects + fixed links across docs)
- Other: add admin components to resources dropdown + fixes to search on mobile.

Closes DX-955

Preview: https://docs-v2-git-docs-router-page-medusajs.vercel.app/v2
2024-10-18 08:24:34 +00:00
Shahed Nasser b07dd33a57 docs-util: add configuration to generate js-sdk reference (#9630) 2024-10-17 19:32:21 +03:00
Shahed Nasser ab113cdc38 chore(js-sdk): add ignore tsdoc tag to client and constructor of inner classes (#9635) 2024-10-17 19:31:51 +03:00
Shahed Nasser 8fddabce04 docs: update curl request to /admin/products (#9641)
Closes DX-1026
2024-10-17 16:21:31 +00:00
Shahed Nasser 4ca5510da9 fix(types): change options to be required in http type (#9642)
`options` is now required when creating a product. This PR updates the http type
2024-10-17 16:13:17 +00:00
Shahed Nasser 31900239b7 fix(core-flows, types): general fixes to types and tsdocs (#9633)
- Export input type of `useQueryGraphStep` step
- Remove duplicate `OrderTransactionDTO`
- Fix some tsdoc errors
2024-10-17 15:50:19 +00:00
Shahed Nasser ea5bff9034 docs: update providers to use ModuleProvider (#9579)
Document change introduced by #9544

> Note: fine to merge now as it requires generating references, which will only happen after the next release.
2024-10-16 11:37:14 +00:00
Shahed Nasser 3610d58f49 docs: fix heroku typo (#9382)
Closes #9356
2024-10-16 10:44:50 +00:00
Shahed Nasser eed88c95ec docs: improved commerce modules [5/5] (#9592)
- Improve remaining commerce modules
- Other: add a note about using methods of the modules' main services.
2024-10-16 10:25:21 +00:00
Shahed Nasser 6e856d3156 docs: added examples page (#9587)
- Added an examples page with examples of all different concepts in Medusa. We'll probably add more examples with time as we see the need for them.
- Small fixes in different pages.

Preview: https://resources-docs-ocb5uyp0o-medusajs.vercel.app/v2/resources/examples
2024-10-16 10:07:39 +00:00
Shahed Nasser ddcb749bc4 docs: added documentation for build command (#9604)
- Added documentation for `medusa build` command
- Update deployment documentation for admin to use `--admin-only` option
2024-10-16 09:37:40 +00:00
Shahed Nasser f6d3453e6d docs: improved commerce modules [4/n] (#9517)
Improve pricing, product, and promotion modules docs

[4/n]
2024-10-16 09:34:36 +00:00
Shahed Nasser 2b77bd85a6 docs-util: fixes for OAS docs generator + framework typedoc config (#9603)
* fix order replaced in OAS response + framework tsdoc config

* fix for some types
2024-10-16 12:17:28 +03:00
Shahed Nasser 714b9e6c98 docs: update resolve path to use src (#9605)
Update path used in `resolve` of modules to start with `src`
2024-10-16 09:10:30 +00:00
Shahed Nasser 6efb5897dc docs: fix package names in module registration (#9590)
* docs: fix package names in module registration

* update references
2024-10-16 09:05:07 +02:00
Shahed Nasser 86f744cf3b fix(create-medusa-app): use db:migrate to run migrations (#9565) 2024-10-14 15:54:05 +00:00
Shahed Nasser 6829d3b162 chore(framework): update TSDocs for medusa config (#9559)
* chore(framework): update TSDocs for medusa config

* update modules tsdocs
2024-10-14 13:45:50 +03:00
Shahed Nasser b6df24463d docs: updates for breaking changes (#9558)
- Update modules registration
- Update `medusa-config.js` to `medusa-config.ts`
- Update the out directory in the admin deployment guide
- Update logger imports
- Other fixes

Note: will need to re-generate references afterwards

Closes #9548
2024-10-14 10:40:30 +00:00
Shahed Nasser 11120a8b7e docs: improve commerce modules [3/n] (#9510)
Improve and add docs for Order and Payment modules

[3/n]

Closes DOCS-966
Closes #9485
2024-10-14 07:20:35 +00:00
Shahed Nasser 74b286b701 docs: added documentation for admin components (#9491)
- Documented common admin components with design that matches the admin.
- Updated existing admin customization snippets to match the admin's design.

Closes DOCS-964
2024-10-14 07:18:38 +00:00
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 c9ce918982 docs: small structure fixed to db command reference (#9446) 2024-10-14 08:58:39 +02:00
Shahed Nasser 69b9e73be7 docs: improve commerce modules [1/n] (#9498)
Improve and add docs for API Key, Auth, and Cart Modules

[1/n]
2024-10-11 15:19:13 +00:00
Shahed Nasser dd162d69be docs-util: fix import in generated workflow hook snippet (#9499) 2024-10-11 17:17:02 +02:00
Shahed Nasser 49a91fd40e docs: redesigned navigation (#9525)
Redesign navigation bar to reflect new design and allow for dropdowns

Closes DX-943
2024-10-11 07:10:00 +00:00
Shahed Nasser bf60983b51 fix(types): fix parameter types for the order module's service (#9513)
Use correct type for the `createOrderLineItemAdjustments` method. The module uses the correct type, only the service has the incorrect one.
2024-10-10 07:20:36 +00:00
Shahed Nasser 7f1f075222 docs: improvements and fixes to components in API reference (#9410)
- Change layout of parameters for clearer display
- Fix schema code blocks being longer than container
- switch between showing required to showing optional indicator
- Fixed code tabs not having copy / report buttons

Closes DOCS-936

Preview: https://api-reference-v2-git-docs-api-ref-comp-improv-medusajs.vercel.app/v2/api/store
2024-10-09 17:51:27 +00:00
Shahed Nasser 3298cd3fd2 docs: improved commerce module docs [2/n] (#9501)
Improve + add docs for commerce modules from currency to inventory

[2/n]
2024-10-09 09:53:17 +00:00
Shahed Nasser e23d2b9ed7 docs: updates in recipes (#9472)
Updates in recipes following release changes
2024-10-07 17:53:53 +00:00
Shahed Nasser f3c8f5efef docs: document using conditional operators in workflows (#9464) 2024-10-07 17:52:30 +00:00
Shahed Nasser 781d0ca624 docs: added docs for reset password (#9306)
- Added to docs on implementing auth flows using the module and API routes how to update a user's password
- Added guide on how to send a notification when a password token is generated
- Added a guide on implementing reset password flow in storefront
- Added OAS for the `/update` and `/reset-password` routes + generated specs for the API reference
2024-10-07 08:04:01 +00:00
Shahed Nasser 522d3ce764 docs: improvements to API reference intro sections (#9397)
- Improve intro sections of API reference to utilize divided columns
- Improve the content of the intro sections
- Add a new Workflows section to explain the workflows badge and how to use it
- Fixes to headings and add anchor for copying the link to a section
- Fixes responsiveness of intro sections on mobile devices
- Other: fix loading not showing when a sidebar category is opened.

Closes DOCS-932, DOCS-934, DOCS-937

Preview: https://api-reference-v2-git-docs-api-ref-intro-fixes-medusajs.vercel.app/v2/api/store
2024-10-06 16:51:08 +00:00
Shahed Nasser ed174826a4 docs: update modules chapter in basics (#9452)
* docs: update modules chapter in basics

* address PR feedback
2024-10-04 14:15:41 +03:00
Shahed Nasser bc8de8e5b1 docs: add section on testing providers (#9453) 2024-10-04 10:29:45 +03:00
Shahed Nasser aec99b49cc chore: fix action name in update on rc release action (#9463) 2024-10-04 10:29:35 +03:00
Shahed Nasser 00a51b59b1 docs: update imports of middlewares and http types (#9440) 2024-10-03 15:56:58 +00:00
Shahed Nasser 1bb3f8b5b1 docs: add a troubleshooting guide for dist imports (#9442) 2024-10-03 14:17:48 +03:00
Shahed Nasser ab5a7ca691 docs: fix infinite scroll, update next.js, other fixes (#9441)
* update nextjs

* badge + scroll fixes
2024-10-03 14:17:33 +03:00
Shahed Nasser 97c193be1b chore: add action to update starter dependencies + update reference actions (#9385)
* chore: add action to update starter dependencies

* change trigger type

* trigger generating references on new RC release
2024-10-03 10:21:12 +03:00
Shahed Nasser a94f30ba97 chore(oas): add more details link to pagination and select fields (#9414)
find-and-replace to add a link to the pagination and field selection sections in parameters.

Closes DOCS-940
2024-10-02 18:41:51 +00:00
Shahed Nasser 0f6f56e764 docs: DX and performance improvements in API reference (#9430)
- Improve scroll behavior between active sections
- Improve lag when clicking on a sidebar item
- Refactor internal working of the `SidebarProvider` to find active items faster.
- Use Next.js's `useRouter` hook for changing the hash (since they added the option to disable scroll)
- Change `isBrowser` from a hook to a provider since it's widely used across applications.
- Other general improvements and fixes.

Closes DOCS-952
2024-10-02 15:51:02 +00:00
Shahed Nasser 5fb9c1f82e chore(oas): general fixes to OAS (#9413)
General fixes to OAS
2024-10-02 15:21:40 +00:00
Shahed Nasser cb5c228a36 fix(create-medusa-app): remove warnings on installation (#9405) 2024-10-02 13:27:13 +03:00
Shahed Nasser 7ce9121095 chore(types, utils): update the TSDocs of AbstractFulfillmentProviderService (#9349)
Updates the `AbstractFulfillmentProviderService` with TSDocs for more useful information and examples

Closes DOCS-950
2024-10-02 09:01:01 +00:00
Shahed Nasser 9811da2960 docs: fix query option in instrumentation (#9395) 2024-10-02 10:29:11 +03:00
Shahed Nasser a662c4b020 fix(medusa-oas-cli): Fix incorrect import (#9404)
* fix(medusa-oas-cli): Fix incorrect import

* update redocly config
2024-10-02 10:28:42 +03:00
Shahed Nasser 7bc7c50eef fix(types, medusa): http types fixes (#9334)
* fix(types, medusa): http types fixes

* fix build error

* remove return fields

* more fixes

* fix cart payload types
2024-10-02 10:28:22 +03:00
Shahed Nasser 8686ca9d12 docs: updates and fixes in utils + fulfillment provider changes (#9347)
* fix config + update deps

* rearrange sidebar + add to examples
2024-10-02 10:27:48 +03:00
Shahed Nasser 07afa8fba6 docs: fix how api reference shows any type (#9340) 2024-10-02 10:27:21 +03:00
Shahed Nasser 1e144e9c08 chore(oas): clean up oas (#9354)
* clean up generated oas

* fix issues in docs-util

* more fixes

* align max level

* validation fix

* add missing summaries

* fix validation

* fix exchanges route
2024-10-02 10:27:02 +03: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 1ad7e7583f docs: fix imports from dist (#9401) 2024-10-01 09:49:37 +00:00
Shahed Nasser 20943902f9 chore: update imports in tsdocs (#9379) 2024-10-01 11:04:03 +02:00