Commit Graph
100 Commits
Author SHA1 Message Date
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
Shahed Nasser 1ebbf3dd33 chore: add condition for running documentation actions (#5418)
* chore: add condition for running documentation actions

* fix condition
2023-10-19 20:53:51 +03:00
Shahed Nasser 28d2f2ea98 docs: fix parameters display in module reference (#5425)
* prettify json output

* fix parameter optional + array children
2023-10-19 19:34:17 +03: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 a27083cd4b chore: fix actions of generating references (#5411) 2023-10-18 20:38:51 +03:00
Shahed Nasser 8d0a45ec14 chore: added TSDocs to product module service interface (#5341)
* added tsdocs for product module service

* general fixes

* added generate github action

* fix typedoc configurations

* update comments

* change configurations

* address PR feedback
2023-10-18 19:41:53 +03:00
Shahed Nasser 49ed7de752 chore: fix OAS for User Login JWT (#5403) 2023-10-18 17:12:30 +03:00
Shahed Nasser a1807aea83 feat(create-medusa-app): add tracking for selected options (#5404)
Adds tracking for selected options in `create-medusa-app` to better understand how users are using Medusa.
2023-10-18 09:02:40 +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
Shahed Nasser cacc443fc2 chore(oas): add note about returned fields in list product variants endpoint (#5360) 2023-10-12 14:55:13 +03:00
Shahed Nasser c02fdeb789 chore(oas): fix typo in product variant's OAS (#5352)
* chore(oas): fix typo in product variant's OAS

* fix oas error
2023-10-12 14:20:08 +03:00
Shahed Nasser a91fca69ac docs: added a note about typescript declaration file (#5361) 2023-10-12 11:08:25 +03:00
Shahed Nasser 2c94186c7d docs: add a note about yarn version support in Medusa Dev CLI guide (#5355) 2023-10-11 20:16:08 +03:00
Shahed Nasser 7a4c9dec49 docs: fix entity file path in Create Entity documentation (#5351) 2023-10-11 19:52:23 +03:00
Shahed Nasser f0af8ecc89 docs: generate pricing module reference (#5349)
* docs: generate pricing module reference

* added notes about new configurations
2023-10-11 14:08:19 +03:00
Shahed Nasser 9c1c19f409 chore(docs-util): fix dependencies installation (#5345) 2023-10-11 10:46:06 +03:00
Shahed NasserandCarlos R. L. Rodrigues 57bd38bb4b chore: added and improved TSDoc of pricing module (#5335)
* adjusted tsdoc of methods and types in pricing module

* finished adding tsdocs

* small fixes

* remove reference files

* added github action

* fix typo in outPath

* Update packages/types/src/shared-context.ts

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>

* fix sharedContext description

* changed branch name of action

* added ignore for is_dynamic

* added private remark

---------

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
2023-10-10 13:23:54 +03:00
Shahed Nasser 418ff2a33a chore: fix tsconfig in utils (#5328) 2023-10-09 18:19:00 +03:00
Shahed Nasser ef3d735113 docs: update price list's user guide (#5323)
* docs: update price list's user guide

* remove import links

* hide import prices docs

* add double quotes

* fix build error

* removed import prices section

* remove text about import
2023-10-09 17:31:32 +03:00
Shahed Nasser 85c4cdf9af chore: fix path prefix of reference generation scripts (#5324)
* chore: fix path prefix of reference generation scripts

* fix build step
2023-10-09 16:43:54 +03:00
Shahed Nasser 05dbc7a877 docs: fix beta tag (#5321) 2023-10-09 14:05:55 +03:00
Shahed Nasser ce93d75cc5 chore: fix generate reference command name in action (#5320)
* chore: fix generate reference command name

* fix require path in typedoc config

* add missing dependencies
2023-10-09 13:45:19 +03:00
Shahed Nasser 4ada22d656 chore: fix OAS of batch delete product prices endpoint (#5318)
* chore: fix OAS of batch delete product prices endpoint

* fix oas check
2023-10-09 13:13:00 +03:00
Shahed Nasser 1c3faee158 docs: fix documentation actions (#5316)
* docs: fix documentation utility scripts

* change branch names
2023-10-09 12:43:14 +03:00
Shahed Nasser 4ca70a0d0c docs: fix horizontal scroll (#5300) 2023-10-05 22:38:54 +03:00
Shahed Nasser 0350eeb0a1 docs: create typedoc theme and plugins for references (#5297)
* update typedoc and its plugins

* refactor existing typedoc configurations

* added new typedoc plugin and themes

* added more customization options

* added more customization options

* refactored doc-utils to a workspace

* fix tsconfig

* update README files

* remove comments

* revert type changes

* remove dependencies no longer needed

* removed modules action
2023-10-05 12:09:42 +03:00
Shahed Nasser b3f75d8f21 docs: add AI Assistant (#5249)
* added components

* added ai assistant button

* change styling

* improve AI assistant

* change to a drawer

* added command support into search

* add AiAssistant to all projects

* remove usage of Text component

* added error handling

* use recaptcha

* fix new configurations

* fix background color

* change suggested questions
2023-10-05 11:10:44 +03:00
Shahed Nasser 0b4e7ef9c3 docs: fix preserve-symlink command for yarn in plugin docs (#5285)
* docs: fix preserve-symlink command for yarn in plugin docs

* added additional tab

* fix npm label
2023-10-04 11:49:25 +03:00
Shahed Nasser 6d9c0eb70b docs: fix usage of non-existing repository in digital products recipe (#5280)
* docs: fix usage of non-existing repository in digital products recipe

* fix content linting
2023-10-04 11:05:23 +03:00
Shahed Nasser 22130ecb63 oas: update examples and security tags (#5256)
- Change cURL examples to use `x-medusa-access-token` instead of bearer
- Add `jwt_token` to `securitySchemes` and update existing `api_token`.
2023-09-29 19:43:57 +00:00
Shahed Nasser 8cf92cea18 docs: improve contentful plugin documentation (#5255)
* docs: improve contentful plugin documentation

* fix eslint errors

* fix styling

* add collection and type migrations
2023-09-29 21:07:31 +03:00
Shahed Nasser 92f1f1a725 docs: fix webshipper plugins array section (#5253) 2023-09-29 17:43:03 +03:00
Shahed Nasser 7016c8940c docs: fix design issues (#5252)
* docs: fix design issues

* fix commands in installation tabs
2023-09-29 17:17:24 +03:00
Shahed Nasser 18a05dee86 fix(create-medusa-app): fix inconsistency in checking errors in migrations (#5189) 2023-09-29 08:26:24 -04:00
Shahed Nasser 70484b4cd4 docs: add Next.js steps to digital product recipe (#5231)
* docs: add Next.js steps to digital product recipe

* fix eslint errors
2023-09-27 20:32:10 +03:00
Shahed Nasser aecf719871 docs(ui,docs): added upgrade guides link to UI docs (#5240)
* added medusa ui index page

* remove console
2023-09-27 20:06:03 +03:00
Shahed Nasser 11b2f1237b docs: fix irregular scrolling in code tabs (#5239)
* docs: fix blocking scroll util

* remove unnecessary util methods
2023-09-27 19:17:04 +03:00
Shahed Nasser f5a698ad6f docs: fix code block's usage of z-index (#5238) 2023-09-27 18:48:18 +03:00
Shahed Nasser 6942a907a5 docs: fix z-index across projects (#5234)
* docs: fix z-index across projects

* remove usage of z-index in UI docs
2023-09-27 16:38:59 +03:00
Shahed Nasser 4c8836b488 docs: fix feedback fields not being passed to tracking (#5225) 2023-09-27 11:00:17 +03:00
Shahed Nasser 987dd8f568 docs: expanded rating form + UI docs improvement (#5211)
* docs: expanded rating form + UI docs improvement

* added props table + changed example
2023-09-26 20:26:09 +03:00
Shahed Nasser dee3419fe8 docs: fix details component + other styling fixes (#5217)
* docs: fix details component

* general styling fixes
2023-09-26 19:03:07 +03:00
Shahed Nasser 63aea62d7a docs: improve tailwind configuration (#5215) 2023-09-26 15:08:30 +03:00
Shahed Nasser 07e65f5aba docs: Improve Loaders documentation (#5205) 2023-09-25 19:03:00 +03:00
Shahed Nasser 797cd48bd3 docs(ui): dark mode fixes (#5204)
* docs(ui): dark mode fixes

* apply color on the body

* remove z-index
2023-09-25 18:36:42 +03:00
Shahed Nasser 0c9d5ea6d4 docs: update contribution guideline (#5188)
* fix ignore command

* fixed ignore script

* docs: update contribution guideline

* fix ignore script

* fix eslint errors

* remove exit option
2023-09-22 16:08:11 +03:00
Shahed Nasser 123b3787d5 docs: general fixes for docs workspace (#5184) 2023-09-22 12:25:48 +03:00
Shahed Nasser 27d74cb399 docs: fix error related to Key type (#5178)
* docs: fix error related to Key type

* fix styling issue
2023-09-21 21:41:18 +03:00
Shahed Nasser fa7c94b4cc docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
2023-09-21 20:57:15 +03:00
Shahed Nasser 89735aa425 docs: fix code in digital product recipe (#5172)
* docs: fix code in digital product recipe

* eslint fixes
2023-09-21 15:20:02 +03:00
Shahed Nasser 889154c440 docs: fix card title in digital products recipe (#5147) 2023-09-19 18:43:23 +03:00
Shahed Nasser d709521826 docs: updated recipes (#5138) 2023-09-19 13:48:27 +03:00
Shahed Nasser a161f689b9 docs: fix SendGrid's dynamic_template_data property (#5112) 2023-09-18 15:06:09 +03:00
Shahed Nasser 0c467012f6 docs: fix retrieve order by display ID code block (#5106)
Fixes #5099
2023-09-18 10:50:54 +03:00
Shahed Nasser beeb0d6154 docs: added docs for multi-language support (#5026)
* docs: added docs for multi-language support

* fix sidebar

* fix sidebar ref

* added config step
2023-09-15 17:21:00 +02:00
Shahed Nasser 09bcbdaea5 docs: fix environment variable names for Railway guide (#5077)
* docs: fix environment variable names for Railway guide

* Update deploying-on-railway.md

* Update deploying-on-railway.md
2023-09-15 14:42:11 +03:00
Shahed Nasser 7d35723023 fix(medusa-react): fix useAdminAddStoreCurrency hook (#5074) 2023-09-15 12:06:12 +02:00
Shahed Nasser 5b09f816cb fix(create-medusa-app): fix command for windows OS (#5061) 2023-09-14 18:07:43 +03:00
Shahed Nasser d14966abca api-ref: fix feedback component client error (#5055) 2023-09-14 17:06:18 +03:00
Shahed Nasser 973c79bef6 docs: change usage of AbstractPaymentService with AbstractPaymentProcessor (#5038)
Fixes #5033
2023-09-13 11:19:25 +03:00
Shahed Nasser adf4903003 docs: added ecommerce recipe (#5017)
* docs: added ecommerce recipe

* fix eslint errors
2023-09-11 18:51:03 +03:00
Shahed Nasser b18b6167a7 docs: added troubleshooting for Next.js with NPX (#5016) 2023-09-11 18:09:26 +03:00
Shahed Nasser fbae7f9654 docs: fix steps in create entity documentation (#5011) 2023-09-11 12:05:25 +03:00
Shahed Nasser d971d5cf91 docs: added new recipes (#4964)
* docs: added new recipes

* added oms recipe

* address PR feedback
2023-09-11 11:31:57 +03:00
Shahed Nasser 5c9f8c7111 docs: add create-medusa-app option in Next.js starter (#5008) 2023-09-11 11:15:10 +03:00
Shahed Nasser 70701b3e8f docs: fix S3 plugin options section (#5007) 2023-09-11 10:52:43 +03:00
Shahed Nasser 7a12aa04ac docs,api-ref: fix kbd styling (#4995)
* docs: fix kbd styling

* additional fixes
2023-09-08 20:18:26 +03:00
Shahed Nasser 1a1fc6c968 docs: add documentation for remaining plugins (#4994)
* docs: add documentation for remaining plugins

* fix eslint errors
2023-09-08 19:18:48 +03:00
Shahed Nasser 1958809fa9 docs: update create-medusa-app to add details about Next.js option (#4991)
* docs: update create-medusa-app to add details about Next.js option

* fix enter
2023-09-08 15:26:39 +02:00
Shahed NasserandOli Juhl c47b7aacbd docs: updated the add fulfillment provider docs (#4986)
* docs: updated the add fulfillment provider docs

* fix eslint errors

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-09-08 15:12:00 +02:00
Shahed Nasser 240b038006 feat(create-medusa-app): add install Next.js storefront option (#4968)
* feat(create-medusa-app): add install Next.js storefront option

* added config for yes option

* added more instructions to exit message

* handle duplicate directories and next errors

* use next.js branch

* add line break in storefront question

* pass next.js directory name as env variable

* change question message

* address PR feedback

* fix(medusa-cli): remove .git directory in `new` command

* fix deleting a directory error
2023-09-08 12:17:48 +02:00
Shahed Nasser 9781089ca3 chore(oas): Update OAS for upload endpoints (#4953)
* chore(oas): Update OAS for upload endpoints

* added changeset

* address pr feedback
2023-09-06 17:39:19 +03:00
Shahed Nasser ddc882faac docs: added multi-region recipe (#4926)
* docs: added a multi-region recipe

* added other category to plugins list

* fix eslint errors

* fix broken link

* add link

* fix sidebar link
2023-08-31 20:38:06 +03:00
Shahed Nasser f9c064f98d docs: added a note about product module in Next.js (#4924) 2023-08-31 16:29:33 +03:00
Shahed Nasser 0627d06f72 docs: updated digitalocean deployment guide (#4923)
* docs: updated digitalocean deployment guide

* remove build from script

* fix text
2023-08-31 15:44:54 +03:00
Shahed Nasser bc4c9e0d32 docs: update admin CLI configurations (#4910)
* docs: update admin configurations

* fix in dev command name
2023-08-30 17:12:16 +03:00
Shahed Nasser b05bae1471 docs: update Create Fulfillment Provider guide (#4911) 2023-08-30 16:03:56 +03:00
Shahed Nasser 359bd290ba docs: added expected columns for imports (#4908)
* docs: added expected columns for imports

* linked from user guide to new sections
2023-08-30 12:00:43 +03:00
Shahed Nasser 33ffdaf42d docs: added B2B recipe (#4901)
* added b2b recipe

* added redirect rule

* fix build errors

* fix broken links
2023-08-29 19:50:14 +03:00
Shahed Nasser e086e3efbd docs: fix customer_id name in create endpoints docs (#4900) 2023-08-29 17:42:05 +03:00
Shahed NasserandOli Juhl f75d9806f9 docs: added rbac recipe (#4895)
* docs: added rbac recipe

* fix eslint errors

* fixed indentation causing build error

* fix build warning

* small fixes

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2023-08-29 15:11:52 +03:00
Shahed Nasser 962c907dfa docs: updated create file service guide (#4887) 2023-08-28 12:50:34 +03:00
Shahed Nasser 17c26c4f66 docs,api-ref: fixed search bugs (#4866) 2023-08-25 18:39:31 +03:00
Shahed Nasser 6d94c0c181 docs: added beta features documentation (#4859) 2023-08-25 14:59:20 +03:00
Shahed Nasser d04b9635f9 chore(oas): fix Get Variant's Inventory OAS (#4856)
* chore(oas): fix Get Variant's Inventory OAS

* fix the curl example
2023-08-25 13:03:55 +03:00
Shahed Nasser f07dc0384f docs,api-ref: added search filters (#4830)
* initial implementation of search modal

* added hit and search suggestions

* added support for multiple indices

* updated sample env

* added close when click outside dropdown

* test for mobile

* added mobile design

* added shortcut

* dark mode fixes

* added search to docs

* added plugins filter

* added React import

* moved filters to configurations

* handled error on page load

* change suggestion text

* removed hits limit

* handle select all

* open link in current tab

* change highlight colors

* added support for shortcuts + auto focus

* change header and footer

* redesigned search ui
2023-08-24 18:36:06 +03:00
Shahed Nasser c58588904c fix(medusa-telemetry): added missing babel dependencies (#4817) 2023-08-23 14:26:06 +02:00
Shahed Nasser 80d603a63d docs: improved glossary definitions (#4820)
* docs: improved glossary definitions

* Update glossary.ts
2023-08-21 13:09:59 +03:00
Shahed Nasser 740a3c6e18 docs: improved glossary feature (#4819) 2023-08-21 12:31:16 +03:00
Shahed Nasser f11375a686 docs: remove yarn create-medusa-app until a fix is out (#4818) 2023-08-21 11:49:18 +03:00
Shahed Nasser f5d8696123 docs: added glossary functionality (#4805) 2023-08-18 17:07:00 +03:00
Shahed Nasser ac25c422a3 docs: added general deployment guide for backend (#4802)
* docs: added general deployment guide for backend

* deleted qovery

* added a note to microtica

* fix icon name
2023-08-18 13:29:17 +03:00
Shahed Nasser fd2dcdf98c docs: improve create-medusa-app guide structure (#4801)
* docs: improved create-medusa-app structure

* change hash link
2023-08-18 11:19:36 +03:00
Shahed Nasser 57bb391146 docs: added new recipes (#4793)
* added new recipes

* added more recipes
2023-08-17 20:37:40 +03:00
Shahed Nasser 3b5590ccec docs: added new database options for create-medusa-app (#4777)
* docs: added new database options for create-medusa-app

* update note

* removed stable option

* add example to connect to Vercel or Supabase database

* added a note about --db-url option

* added a note about --no-migrations

* added troubleshooting guide for invalid token error with no-browser

* fix link
2023-08-17 20:21:32 +03:00
Shahed Nasser 80b1bff8cb docs: update admin extension docs (#4778)
* docs: update admin extension docs

* eslint fixes

* fix broken links

* fix broken link

* added admin upgrade guide

* fix lint errors
2023-08-17 20:04:13 +03:00
Shahed Nasser 75881a2cfe docs: added UI link to navigation bar (#4796) 2023-08-17 19:50:10 +03:00