Commit Graph

127 Commits

Author SHA1 Message Date
Shahed Nasser
6780ea9f13 docs: document missing events in reference (#10779) 2024-12-31 12:44:38 +02:00
Shahed Nasser
ebca8fed28 docs: revise commerce modules overview pages (#10738)
* revise API Key Module overview

* revise auth module

* support ref sidebar items

* remove examples

* revise cart module

* revise currency

* revise customer module

* revise fulfillment module

* revise inventory module

* revise order module

* revise payment

* revise pricing module

* revise product module

* revise promotion module

* revise region module

* revise sales channel module

* revise stock location module

* revise store module

* revise tax module

* revise user module

* lint content + fix snippets
2024-12-26 10:32:16 +02:00
Shahed Nasser
8441d2ab9d docs: improve link docs for commerce modules (#10726) 2024-12-24 17:19:39 +02:00
Shahed Nasser
041baafd38 docs: split admin widget zone to pages (#10719) 2024-12-24 12:29:41 +02:00
Shahed Nasser
fd1afa8bc9 docs: split events reference across modules (#10711)
* docs: split events reference across modules

* add lint exceptions
2024-12-24 09:54:51 +02:00
Shahed Nasser
870cb6e88c docs: update typedoc, convert packages to esm, generate references (#10699) 2024-12-23 15:20:09 +02:00
Shahed Nasser
a399781b9b docs: integrate shipstation guide (#10623)
* first draft

* finalized first draft + added link to sidebar

* fix lint errors

* type changes

* updates to createFulfillment

* updates

* more updates

* add package weight

* added note about package

* fix up order items fulfillment

* add meta image

* address comment
2024-12-23 10:20:19 +02:00
Shahed Nasser
0f5d640736 docs: generate references manually for v2.1.2 (#10639)
* docs: manually generate references for v2.1.2

* more changes
2024-12-17 19:20:44 +02:00
Shahed Nasser
f78b410b96 docs: add customize stripe integration in next.js guide (#10583) 2024-12-16 14:58:40 +02:00
Shahed Nasser
fd23f13cfd docs: document when-then name 2024-12-11 11:00:25 +02:00
Shahed Nasser
ab1bfb966d docs: generate references manually for 2.1.1 (#10534)
* docs: generate references manually for 2.1.1

* re-generate for core-flows

* Revert "re-generate for core-flows"

This reverts commit ff785c80214dc6125e2da4c6e8a674a87b03e9dd.
2024-12-10 18:49:30 +02:00
Shahed Nasser
e41ab50f59 docs: added restock notification guide (#10413)
* docs: added restock notification guide

* changes

* lint fixes

* fixes

* more changes

* remove get email step

* add og image

* update sendRestockNotificationsWorkflow

* updates

* fix links
2024-12-10 16:50:40 +02:00
github-actions[bot]
9534751b5c chore(docs): Generated References (automated) (#10508)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2024-12-09 15:27:01 +02:00
Shahed Nasser
1cb885d566 docs: generate references manually (#10438) 2024-12-04 21:37:07 +02:00
Shahed Nasser
768f970926 docs: changes to deployment + remove admin deployment guides (#10345)
* docs: change headings and text in deployment

* remove admin deployment guide

* generate changes
2024-11-28 14:48:10 +02:00
Shahed Nasser
030b0cc095 docs: generate references manually (#10325)
* docs: generate references

* prep changes
2024-11-27 19:27:25 +02:00
Shahed Nasser
537a609dfb docs: add resend integration guide (#10268)
* initial guide

* initial draft

* finished draft

* address feedback

* add meta image
2024-11-27 13:28:52 +02:00
github-actions[bot]
d5ee0070b4 chore(docs): Generated References (automated) (#10276)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `order`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `search`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-11-26 09:24:41 +00:00
Shahed Nasser
a429a267f1 docs: add Sanity integration guide (#10152)
* docs: add integrate to Sanity guide

* address PR feedback

* added more screenshots

* edit introduction

* added meta images + changes
2024-11-20 16:17:33 +02:00
Shahed Nasser
9c39cf69fb docs: add guide on how to translate admin (#10095)
* docs: add guide on how to translate admin

* added a link from the main docs
2024-11-14 17:17:01 +02:00
github-actions[bot]
c3a0123958 chore(docs): Generated References (automated) (#10046)
Generated the following references:
- `core_flows`
- `js_sdk`
- `modules`
- `product`
- `types`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-11-12 10:30:09 +00:00
github-actions[bot]
fc01ae68c0 chore(docs): Generated References (automated) (#9961)
Generated the following references:
- `api_key`
- `cart`
- `cart_models`
- `core_flows`
- `customer`
- `fulfillment`
- `inventory_next`
- `js_sdk`
- `medusa_config`
- `modules`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `stock_location_next`
- `tax`
- `tax_provider`
- `types`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-11-11 08:17:50 +00:00
Shahed Nasser
c7b24eb3ec docs: remove upgrade guides doc (#9845) 2024-11-10 14:13:00 +01:00
github-actions[bot]
c4cd2c2d7c chore(docs): Generated References (automated) (#9803)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-10-26 16:33:31 +02:00
github-actions[bot]
d40499ca6a chore(docs): Generated References (automated) (#9772)
Generated the following references:
- `auth_provider`
- `core_flows`
- `js_sdk`
- `medusa_config`
- `modules`
- `payment_provider`
- `tax`
- `tax_provider`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-25 07:08:57 +00:00
github-actions[bot]
5deeae060a chore(docs): Generated References (automated) (#9727)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:41:14 +00: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
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
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
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
github-actions[bot]
f2d662efca chore(docs): Generated References (automated) (#9567)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-10-14 19:59:14 +02:00
github-actions[bot]
224e530453 chore(docs): Generated References (#9551)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `fulfillment`
- `inventory_next`
- `modules`
- `modules_sdk`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `search`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-10-14 10:33:21 +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
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
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
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
1bb3f8b5b1 docs: add a troubleshooting guide for dist imports (#9442) 2024-10-03 14:17:48 +03:00
github-actions[bot]
c536f7caf5 chore(docs): Generated References (automated) (#9436)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-10-03 11:03:35 +03:00
github-actions[bot]
4a68bc1334 chore(docs): Generated References (#9232)
Generated the following references:
- `modules`
- `modules_sdk`
- `types`
2024-09-23 07:33:39 +00:00
github-actions[bot]
a00c2ddb31 chore(docs): Generated References (#9187)
Generated the following references:
- `modules`
2024-09-19 12:20:02 +00:00
github-actions[bot]
175ca30f4f chore(docs): Generated References (#9153)
Generated the following references:
- `api_key`
- `auth`
- `auth_provider`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `customer_models`
- `dml`
- `file`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`
2024-09-17 07:17:55 +00: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
4b663a4559 docs: document events reference (#9080)
- Remove old hidden reference files that document modules' events
- Add new events reference for workflow events
- Reference events reference in the main docs
2024-09-10 12:20:09 +00:00
Shahed Nasser
a5e8a55d63 docs: added storefront development guide on retrieving variant inventory details (#9032)
* docs: added storefront development guide on retrieving variant inventory details

* fix vale error
2024-09-09 10:02:59 +03:00
github-actions[bot]
95a3ac045d chore(docs): Generated References (#9034)
Generated the following references:
- `auth`
- `core_flows`
- `fulfillment`
- `modules`
- `modules_sdk`
- `order`
- `types`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-06 12:39:45 +00:00
Shahed Nasser
a28c911c24 docs: update auth docs + add new storefront guides (#9020)
* docs: update auth docs + add new storefront guides

* lint content

* fix vale error

* add callback response schema

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

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

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

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

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

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

* address PR comments

* replace google -> github

* better explanation for refresh token

---------

Co-authored-by: Stevche Radevski <sradevski@live.com>
2024-09-06 15:26:10 +03:00