Commit Graph

79 Commits

Author SHA1 Message Date
Omar Hawwash
4fbe02b299 docs: updated medusa develop command (#5698) 2023-11-23 09:52:45 +00:00
Shahed Nasser
2850e9a772 docs: redesigned admonitions (#5689) 2023-11-22 17:07:29 +00:00
Shahed Nasser
00d59e28e9 docs: redesign tabs (#5687)
* redesigned tabs

* design fixes
2023-11-22 16:01:51 +00:00
Shahed Nasser
9c7ac7332a docs: added migration action to upgrade guide (#5669) 2023-11-21 14:46:22 +00:00
github-actions[bot]
2b9e8bda5e chore(docs): Generated References (#5666)
Generated the following references:
- `entities`
- `js-client`
- `pricing`
- `services`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-11-21 12:36:09 +00:00
Nicklas Gellner
4774b8ff3a Add missing link to admin-guide on translations (#5665)
Added missing link. @shahednasser can see you often use markdown references for other links, let me know if you prefer my submissions to be in similar format.
2023-11-21 11:56:48 +00:00
github-actions[bot]
d3e8efd573 chore(docs): Generated Docs Announcement Bar (automated) (#5661)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-11-21 09:18:07 +00:00
Shahed Nasser
9c7f95c3d5 docs: documentation for v1.18 (#5652)
* docs: documentation for v.17.5

* fix links

* updated version number
2023-11-21 08:57:11 +00:00
Shahed Nasser
c51dce164d docs: general fixes to references (#5653)
* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
2023-11-17 19:36:58 +02:00
Shahed Nasser
95aa5a2d28 docs: generate inventory and stock location references (#5645) 2023-11-16 11:10:23 +02:00
github-actions[bot]
ecabd38b07 chore(docs): Removed Docs Announcement Bar (automated) (#5644)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-11-16 10:13:55 +02:00
Shahed Nasser
edeec07466 docs: added troubleshooting for postgres docker container (#5629)
* docs: added troubleshooting for postgres docker container

* fix component name
2023-11-14 12:27:38 +02:00
Shahed Nasser
c6dff873de docs: update docusaurus to v3 (#5625)
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
2023-11-13 20:11:50 +02:00
Shahed Nasser
c7b8d060d7 docs: add note about ttl in redis cache module (#5617) 2023-11-13 10:42:52 +02:00
github-actions[bot]
39649b3552 chore(docs): Generated References (#5602)
Generated the following references:
- `pricing`
- `product`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-11-10 17:31:02 +00:00
github-actions[bot]
5f4317b9d7 chore(docs): Generated Docs Announcement Bar (automated) (#5600)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-11-10 12:56:46 +00:00
Oli Juhl
02e2ee4e8a docs: cache-redis breaking changes (#5590)
* docs: cache-redis breaking changes

* remove section
2023-11-10 11:00:22 +01:00
Shahed Nasser
d4b8a89e66 docs: updated API Routes and Middlewares docs (#5588)
* docs: updated API Routes and Middlewares docs

* fix eslint errors
2023-11-10 11:00:08 +01:00
Shahed Nasser
3781ac4631 docs: added troubleshooting guide for promise.all (#5586)
* docs: added troubleshooting guide for promise.all

* fix eslint errors
2023-11-10 10:59:52 +01:00
Shahed Nasser
d74df4878f docs: fix expandable link in ParameterType (#5595) 2023-11-09 21:20:54 +02:00
github-actions[bot]
f35fcb810f chore(docs): Generated References (#5593)
* chore(docs): Generated References (automated)

* fix sidebar and links

* removed reflection path section

---------

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
Co-authored-by: Shahed nasser <shahednasser@gmail.com>
2023-11-09 20:23:25 +02:00
Shahed Nasser
91615f9c45 chore: improve JS Client TSDoc comments (#5582)
* add oas schema to tsdoc parser

* add tsdoc (part 1)

* Finished tsdoc in js client

* general fixes

* added tsdoc in core medusa package

* parse schema tags in model files

* added maxlevel option

* added more tsdoc

* added tsdoc in core

* added TSDoc in core package

* generated client types

* support featureFlag and expandable tags

* added support for resource feature flag note

* fix api ignore plugin

* added eslint plugin

* support feature flag and expandable badges

* adjusted overview page + generated reference

* revert generated files

* added changeset

* add details about new typedoc options

* fix broken link
2023-11-09 12:51:17 +02:00
github-actions[bot]
71853eafdd chore(docs): Removed Docs Announcement Bar (automated) (#5574)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-11-07 10:20:13 +02:00
Nick Miller
e4157875b5 docs(create tax provider): tax line code required (#5540)
While I was developing a custom tax provider, I ran into a pretty frustrating issue related to multiple tax lines and incorrect / unexpected tax total calculations. I outlined the issue in discord, before finding the solution: https://discord.com/channels/876835651130097704/1169705457804398662

After some digging, I found this issue from a while back: https://github.com/medusajs/medusa/pull/1262, where it states there is now a unique constraint on `item_id, code` and `shipping_method_id, code`. But, in the current documentation for creating a custom tax provider, it states these fields as part of the tax line items returned are optional.

If these `code` values are left out, it can cause tax lines to be applied multiple times (as seen here as well: https://github.com/medusajs/medusa/issues/1901)

I'm not entirely sure how this should be phrased in the documentation, so I just wanted to get this up and on your radar for resolution. If it ends up being that `code` truly should not be optional, I suspect some type definitions would need to change as well?
2023-11-06 17:12:56 +00:00
Shahed Nasser
0c9216c225 docs: add missing mime_type in digital products recipe (#5569)
* docs: add missing mime_type in digital products recipe

* fix lint error
2023-11-06 14:35:23 +02:00
Stefanos Chalkidis
57c3a24ad3 docs(create-events-module): fixed typos (#5524) 2023-11-02 18:19:25 +00:00
Stefanos Chalkidis
febbf398ef docs(create-scheduled-job): rewrote sentence (#5525) 2023-11-02 17:36:10 +00:00
github-actions[bot]
aa2bb7a31b chore(docs): Generated References (#5516)
Generated the following references:
- `js-client`
- `pricing`
- `services`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-11-02 09:16:47 +00:00
github-actions[bot]
6060b88360 chore(docs): Generated Docs Announcement Bar (automated) (#5515)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2023-11-01 08:45:15 +01:00
Shahed Nasser
7f9c4dea66 docs: improve UX of recipe learning path (#5477)
* docs: improve UX of recipe learning path

* fix icon colors
2023-10-26 16:05:17 +03:00
Shahed Nasser
8bb8eb530b docs: added documentation for logging (#5469) 2023-10-25 12:49:37 +03:00
github-actions[bot]
db8a2f80a3 chore(docs): Removed Docs Announcement Bar (automated) (#5466)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2023-10-25 10:06:59 +03:00
Shahed Nasser
0eb56519e9 docs: improved create-medusa-app structure (#5458) 2023-10-24 18:29:05 +03:00
Shahed Nasser
1a10822cae docs: update override price selection strategy documentation (#5438)
* docs: update override price selection strategy documentation

* fix eslint errors
2023-10-20 20:17:45 +03:00
github-actions[bot]
0ffa48b07f chore(docs): Generated Pricing Module Reference (#5432)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-20 12:08:59 +00:00
github-actions[bot]
39de54e2e8 chore(docs): Generated JS Client Reference (#5434)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-20 11:47:19 +00:00
github-actions[bot]
8203dec3e2 chore(docs): Generated Product Module Reference (#5430)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-20 11:31:34 +00:00
github-actions[bot]
9dcd62c731 chore(docs): Generated JS Client Reference (#5421)
* chore(docs): Generated JS Client Reference (automated)

* fix js client reference

* fix links

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed nasser <shahednasser@gmail.com>
2023-10-20 14:01:27 +03:00
Shahed Nasser
83f46b9b32 docs: general fixes and enhancements (#5429)
* fix #5427

* fixes #5424

* add new s3 option

* make learning path steps clickable

* remove admin demo link

* fix documentation job conditions

* update user guide images

* update commerce modules titles to match their respective pages

* change icon of discount card

* change ref to head_ref in action condition

* remove refs prefix

* fix vale action's condition
2023-10-20 13:34:40 +03:00
github-actions[bot]
54659ae79f chore(docs): Generated Entities Reference (automated) (#5420)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-10-19 17:37:30 +00:00
github-actions[bot]
38bbc806e0 chore(docs): Generated Docs Announcement Bar (automated) (#5419)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-10-19 17:17:59 +00:00
github-actions[bot]
5c8a1eef12 chore(docs): Generated Services Reference (automated) (#5423)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-10-19 16:59:51 +00:00
Shahed Nasser
c28935b4e8 docs: update endpoints to use file-routing approach (#5397)
- Move the original guides for creating endpoints and middlewares to sub-sections in the Endpoints category.
- Replace existing guides for endpoints and middlewares with the new approach.
- Update all endpoints-related snippets across docs to use this new approach.
2023-10-19 15:56:26 +00:00
Shahed Nasser
fc01375a8d docs: fix q parameter in search products section (#5399) 2023-10-17 19:57:36 +03:00
Shahed Nasser
c089b0f54b docs: added a note about official translations (#5398) 2023-10-17 19:36:58 +03:00
Shahed Nasser
2d74ec256f docs: resdesign and restructure modules references (#5372)
* docs: change format of module reference

* description fix

* update structure + comments

* added new options to README

* small text fix

* change section ordering

* change how required/optional are shown

* remove optional text

* docs: redesigned accordion
2023-10-16 19:51:55 +03:00
Shahed Nasser
3dada88c81 docs: fix links to create notification provider (#5380) 2023-10-16 13:20:51 +03:00
Nicklas Gellner
4fc48db11e docs: fix link not showing correctly (#5373)
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-10-16 11:18:45 +03:00
Nicklas Gellner
9e19359b5d docs: fix naming of stock location module (#5368)
It seems like we are using "Stock Location module" and not "Stock Level module"
2023-10-13 10:27:37 +03:00
Shahed Nasser
a91fca69ac docs: added a note about typescript declaration file (#5361) 2023-10-12 11:08:25 +03:00