Commit Graph
100 Commits
Author SHA1 Message Date
Shahed Nasser b23f0f8188 docs: change notes across docs based on redesign (#8662)
Change the prerequisites / soon / other notes based on latest redesign

Depends on #8661
2024-08-23 07:59:48 +00:00
Shahed Nasser 320b01f45d docs: redesign search + re-introduce ai assistant in v2 docs (#8678)
* docs: redesign search + re-introduce ai assistant in v2

* change version in ui

* show icon in case of error

* fixes based on feedback
2024-08-23 10:42:37 +03:00
Shahed Nasser c63a08fb03 docs: second round of polishing (#8724)
* docs: second round of polishing

* fix overflowing width
2024-08-23 10:42:23 +03:00
Shahed Nasser bc74e381ad feat(utils): use dotenv-expand to allow variables within env (#8720) 2024-08-22 13:51:36 +03:00
Shahed Nasser 0acd94aac3 docs: refactor medusa workflows reference (#8692)
* docs: fix handling of namespaces in core flows under definitions directory

* change nested handling

* docs-util: expand workflows under definitions in workflows reference

* remove check for definitions
2024-08-22 13:39:52 +03:00
Shahed Nasser 64820cebef chore(core-flows): move cart and line item flows outside definition (#8703)
* chore(core-flows): move cart and line item flows outside definition

* remove all references of definition

* export cart and line items
2024-08-22 12:19:37 +03:00
Shahed Nasser 810debc7bb docs: add a note about installing preview version (#8648)
- Add a note about ensuring a package's version is set to `preview` in `package.json`
- Add a troubleshooting guide for deployments with a section about preview versions
- Added a troubleshooting section to the railway deployment guide about preview versions

Closes #8646
Closes DOCS-913
2024-08-22 08:33:24 +00:00
Shahed Nasser f00889fe4e docs: fix link to payment concept guide in sidebar (#8708) 2024-08-21 20:05:07 +02:00
Shahed Nasser b6f990c017 docs: design polish (#8696)
* polish

* finish polish

* change typography
2024-08-21 20:04:43 +02:00
Shahed Nasser a3c311126e docs: fix algolia cron script (#8701) 2024-08-21 20:01:36 +02:00
Shahed Nasser f3e4b7dfd0 docs: fix tooltip placement and width in workflows reference (#8691) 2024-08-21 17:49:24 +03:00
Shahed Nasser 64283d0e83 docs: redesign API runner (#8688)
* fix up block style + plain theme color

* initial redesign

* docs: redesign API Runner

* revert yarn.lock changes
2024-08-21 17:48:16 +03:00
Shahed Nasser 539266559c chore: update the medusa config TSDocs + options (#8697) 2024-08-21 17:46:14 +03:00
Shahed Nasser 1e07ab1b8d docs: fix broken pages due to remark plugin (#8694)
* docs: fix broken pages due to remark plugin

* refactor condition

* Update component-link-fixer.ts
2024-08-21 15:29:46 +03:00
Shahed Nasser 2f0166901f docs: fix response code snippet in api reference (#8689) 2024-08-21 11:52:22 +02:00
Shahed Nasser 9734ad1e51 docs: fix category not opening in api reference from algolia search (#8690) 2024-08-21 11:52:13 +02:00
Shahed Nasser b4d8e265e3 docs: redesign cards (#8671)
* docs: redesign cards

* fix build error
2024-08-20 14:48:17 +02:00
Shahed Nasser 48fe819d9e docs: redesign vertical tabs (#8673) 2024-08-20 14:48:09 +02:00
Shahed Nasser 43202dde0f docs: redesign footer (#8651) 2024-08-20 14:47:53 +02:00
Shahed Nasser b8ba020cd5 docs: redesign tables (#8653)
* docs: redesign tables

* fixes
2024-08-20 14:47:36 +02:00
Shahed Nasser 73905c14b1 docs: redesign notes (#8661)
* docs: redesign notes

* fix color for warning notes

* allow optional links

* show links in a note

* allow line code in notes
2024-08-20 14:47:24 +02:00
Shahed Nasser 45f9961d19 docs: remove link to events reference (#8669) 2024-08-20 12:32:04 +02:00
Shahed Nasser 1020ab0b97 docs: improve main docs and resources sidebar (#8664) 2024-08-20 12:31:50 +02:00
Shahed Nasser a77c23c915 docs: redesign code highlights + add default code titles (#8628)
* docs: code highlights improvements + default titles

* spacing fixes

* fix terminal detection

* add padding for non-terminal one liners
2024-08-19 13:34:07 +03:00
Shahed Nasser 800d034c89 docs: update algolia (#8625)
Update algolia to fix issues with highlighting and snippets
2024-08-19 07:12:02 +00:00
Shahed Nasser c479fe8220 docs: added edit date (#8623) 2024-08-19 09:47:57 +03:00
Shahed Nasser 66c39ef876 docs: bug fixes for copy and color mode (#8626)
* docs: bug fixes for copy and color mode

* remove unused dependency
2024-08-18 17:01:15 +02:00
Shahed Nasser 559a6d70d9 docs: remove steps from workflows reference overview (#8595)
* docs: remove steps from workflows reference overview

* fix styling of typelist element

* fix categories with no items showing
2024-08-16 12:37:13 +03:00
Shahed Nasser f0f83afdd9 docs-util: fix update OAS schema (#8556)
* docs-util: fix update OAS schema

* fix to updating

* fix condition
2024-08-16 12:37:03 +03:00
Shahed Nasser 9bdcdc76a8 docs: redesign help button (#8610)
Redesign help button

Closes DOCS-817
2024-08-16 06:40:05 +00:00
Shahed Nasser 0cc2a62b9b docs: collapse sidebar by default in main docs + persist state (#8608)
* docs: collapse sidebar by default in main docs + persist state

* persist sidebar hidden
2024-08-16 09:29:14 +03:00
Shahed Nasser 1bfdceb34c docs: fix usage of AdminCreateProduct in validation of digital product recipe (#8601) 2024-08-16 09:28:31 +03:00
Shahed Nasser f00e61707c docs: update colors and typography (#8604) 2024-08-16 09:28:16 +03:00
Shahed Nasser 12728f17ad docs: fix scroll top margin (#8605) 2024-08-16 09:28:02 +03:00
Shahed Nasser 5abe9f9c66 docs: fix expand badge (#8611)
* fix component

* update expand URL
2024-08-16 09:26:16 +03:00
Shahed Nasser 47eb19ca5d docs: add associated workflow badge in api reference (#8613) 2024-08-16 09:26:04 +03:00
Shahed Nasser 0b6bc7e05f docs: redesign pagination (#8614) 2024-08-16 09:25:53 +03:00
Shahed Nasser 4bd0917aed docs: change workflow diagram to list (#8602) 2024-08-15 16:47:27 +03:00
Shahed Nasser b4d4b10ba5 docs: fix $lt and $gt in api reference (#8580) 2024-08-15 16:47:09 +03:00
Shahed Nasser 198d7c9927 docs: add a section in the book on how to retrieve a relationship (#8594) 2024-08-15 16:30:00 +03:00
Shahed Nasser 3bdfb66238 docs: change from showing required to showing optional in types references (#8593) 2024-08-15 16:29:49 +03:00
Shahed Nasser b7bb793f03 feat(medusa-oas-cli): automatically fix missing circular references (#8600) 2024-08-15 13:31:47 +03:00
Shahed Nasser b4f3b8a79d docs: redesign sidebar (#8408)
* initial changes

* redesign the sidebar + nav drawer

* changes to sidebar items

* finish up sidebar redesign

* support new sidebar in resources

* general fixes

* integrate in ui

* support api reference

* refactor

* integrate in user guide

* docs: fix build errors

* fix user guide build

* more refactoring

* added banner

* added bottom logo + icon

* fix up sidebar

* fix up paddings

* fix shadow bottom

* docs: add table of content (#8445)

* add toc types

* implement toc functionality

* finished toc redesign

* redesigned table of content

* mobile fixes

* truncate text in toc

* mobile fixes

* merge fixes

* implement redesign

* add hide sidebar

* add menu action item

* finish up hide sidebar design

* implement redesign in resources

* integrate in api reference

* integrate changes in ui

* fixes to api reference scrolling

* fix build error

* fix build errors

* fixes

* fixes to sidebar

* general fixes

* fix active category not closing

* fix long titles
2024-08-15 12:13:13 +03:00
Shahed Nasser 92a7b5b4c0 docs-util: fix OAS generation error (#8577) 2024-08-14 11:21:22 +03:00
Shahed Nasser cd0acbd921 docs: fixes and preparations for workflows reference (#8579)
- Fix the merger configuration that adds the correct slug / sidebar labels
- Add an overview page for the workflows reference.
- Fixes to components and build scripts
2024-08-13 12:30:55 +00:00
Shahed Nasser 1c8aeb9735 chore(medusa,types): [14/14] Add request types to API routes (#8576)
* chore(medusa,types): [14/14] Add request types to API routes

* more types
2024-08-13 12:57:13 +03:00
Shahed Nasser 5ff5159cee chore(medusa,types): [13] Add request types to API routes (#8575) 2024-08-13 12:56:54 +03:00
Shahed Nasser 369d7b54d2 chore(medusa,types): [12] Add request types to API routes (#8574) 2024-08-13 12:56:35 +03:00
Shahed Nasser 82de6572f9 chore(medusa,types): [11] Add request types to API routes (#8572) 2024-08-13 12:56:18 +03:00
Shahed Nasser fc439a32f1 chore(medusa,types): [8] Add request types to API routes (#8565) 2024-08-13 10:10:10 +03:00
Shahed Nasser 571a3d1671 chore(medusa,types): [7] Add request types to API routes (#8564)
Add request types as type arguments in API routes. This also includes adding / rearranging types under the `types` package.

PR 7/n
2024-08-13 07:00:36 +00:00
Shahed Nasser 163205a9a2 docs-util: associate an API route with the workflow it uses (#8554) 2024-08-13 09:56:06 +03:00
Shahed Nasser 705ea0ad33 docs: improve the workflow hooks guide (#8538)
* initial

* docs: improve workflow hook guides
2024-08-13 09:55:37 +03:00
Shahed Nasser d0db833817 docs: added troubleshooting for using pnpm (#8537) 2024-08-13 09:54:56 +03:00
Shahed Nasser 35da5dedc1 docs: fix build errors + update medusa docs link (#8550)
* docs: update medusa docs link

* fix @medusajs/icon version

* fix user guide build

* fix build error
2024-08-13 08:51:20 +02:00
Shahed Nasser b78e286224 chore(medusa,types): [10] Add request types to API routes (#8567) 2024-08-13 09:38:56 +03:00
Shahed Nasser 61cbc8c0be chore(medusa,types): [9] Add request types to API routes (#8566) 2024-08-13 09:38:33 +03:00
Shahed Nasser 6d210c67b1 chore(medusa,types): [6] Add request types to API routes (#8563)
* chore(medusa,types): [6] Add request types to API routes

* more types
2024-08-13 09:37:36 +03:00
Shahed Nasser eb331a4bca chore(medusa,types): [5] Add request types to API routes (#8562)
* chore(medusa,types): [5] Add request types to API routes

* more types
2024-08-13 09:37:24 +03:00
Shahed Nasser 078c2df773 chore(medusa,types): [4] Add request types to API routes (#8561) 2024-08-13 09:37:11 +03:00
Shahed Nasser 578e5182dd chore(medusa,types): [3] Add request types to API routes (#8560)
* chore(medusa,types): [3] Add request types to API routes

* more types
2024-08-13 09:36:56 +03:00
Shahed Nasser e5e8489cc0 chore(medusa,types): [2] Add request types to API routes (#8559)
* chore(medusa,types): [2] Add request types to API routes

* fix up base currency
2024-08-13 09:36:41 +03:00
Shahed Nasser 24985cf89d chore(medusa,types): [1] Add request types to API routes (#8558)
Add request types as type arguments in API routes. This also includes adding / rearranging types under the `types` package.

PR 1/n
2024-08-12 11:27:00 +00:00
Shahed Nasser f14f398685 feat(create-medusa-app): prompt for database name with credentials (#8552)
* feat(create-medusa-app): prompt for database name with credentials

* refactor
2024-08-12 11:52:21 +03:00
Shahed Nasser a19c562bec docs-util: add support for workflows in markdown theme (#8485)
* add template for workflows

* initial changes

* added support for parallel steps

* added support for when

* added merge options

* fix merge options

* fix to tooltip

* clean up

* remove redirects

* fixes

* theme fixes + added merge options

* generate hook examples + fixes

* changed namespaces

* add custom autogenerator

* change type of additional data
2024-08-09 16:35:52 +03:00
Shahed Nasser 79b49c1288 chore(core-flows): export used steps / workflows (#8534)
Export steps / workflows I missed that weren't exported but are used by other workflows
2024-08-09 13:29:54 +00:00
Shahed Nasser f659c6d8bd chore(core-flows): [10] export types and types, add basic TSDocs (#8520)
* chore(core-flows): [10] export types and types, add basic TSDocs

* fix overlapping names

* fix overlapping name
2024-08-09 09:08:27 +02:00
Shahed Nasser f9a8fcc0bc chore(core-flows): [13] export types and steps, add basic TSDocs (#8523) 2024-08-08 21:14:10 +03:00
Shahed Nasser 10f72f15b0 chore(core-flows): [15] export types and steps, add basic TSDocs (#8525) 2024-08-08 21:13:55 +03:00
Shahed Nasser 6efdfbc9a6 chore(core-flows): [18/18] export types and types, add basic TSDocs (#8529) 2024-08-08 20:03:49 +03:00
Shahed Nasser faa09d12f6 chore(core-flows): [17] export types and steps, add basic TSDocs (#8528) 2024-08-08 20:03:38 +03:00
Shahed Nasser 8ee3da4644 chore(core-flows): [16] export types and steps, add basic TSDocs (#8527) 2024-08-08 20:03:27 +03:00
Shahed Nasser e386216512 chore(core-flows): [14] export types and steps, add basic TSDocs (#8524) 2024-08-08 20:03:13 +03:00
Shahed Nasser 288ed2747b chore(core-flows): [12] export types and types, add basic TSDocs (#8522) 2024-08-08 20:02:42 +03:00
Shahed Nasser 4c2d605599 chore(core-flows): [11] export types and types, add basic TSDocs (#8521) 2024-08-08 20:02:28 +03:00
Shahed Nasser 945b920708 chore(core-flows): [9] export types and types, add basic TSDocs (#8519)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 9/n
2024-08-08 16:41:12 +00:00
Shahed Nasser 6e4037edf4 chore(core-flows): [8] export types and types, add basic TSDocs (#8517)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 8/n
2024-08-08 16:39:32 +00:00
Shahed Nasser 89fd065fa3 chore(core-flows): [7] export types and types, add basic TSDocs (#8514)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 7/n
2024-08-08 16:38:10 +00:00
Shahed Nasser 0bfe31e594 chore(core-flows): [6] export types and types, add basic TSDocs (#8512)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 6/n
2024-08-08 16:37:03 +00:00
Shahed Nasser f9989e1659 chore(core-flows): [5] export types and types, add basic TSDocs (#8510)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 5/n
2024-08-08 14:15:06 +00:00
Shahed Nasser cb6796fe4b chore(core-flows): [2] export types and types, add basic TSDocs (#8505)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 2/n
2024-08-08 14:14:55 +00:00
Shahed Nasser 1bb4e764d1 chore(core-flows): [3] export types and types, add basic TSDocs (#8507)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 3/n
2024-08-08 14:12:05 +00:00
Shahed Nasser 9ea0783494 chore(core-flows): [4] export types and types, add basic TSDocs (#8509)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 4/n
2024-08-08 14:11:52 +00:00
Shahed Nasser 73cc66905a chore(core-flows): [1] export types and types, add basic TSDocs (#8504)
This PR exports types and steps from the core-flows package, and adds simple TSDocs for workflows / steps. This is essential for the workflows reference.

PR 1/n
2024-08-08 13:15:44 +00:00
Shahed Nasser fe200e0bb3 docs-util: added a namespaces plugin (#8500)
Added a namespaces plugin that allows generating namespaces and automatically adds reflections in a path pattern to the namespace.

This is particularly useful for the workflows reference, as workflows under the `**/packages/core/core-flows/**/workflows/**` path pattern are shown under a Workflows title, and steps under the path pattern `**/packages/core/core-flows/**/steps/**` are shown under a Steps title.
2024-08-08 13:03:42 +00:00
Shahed Nasser eb09a063dc chore: fix actions generating docs (#8486)
* chore: fix actions generating docs

* add to vale tests
2024-08-08 09:22:55 +03:00
Shahed Nasser c870302400 docs-util: added workflows typedoc plugin (#8463)
* initial changes

* finish workflow plugin

* add comments

* remove todo
2024-08-06 14:23:24 +03:00
Shahed Nasser decd830474 docs: added a note about admin customizations as arrow functions (#8387) 2024-08-06 09:44:22 +02:00
Shahed Nasser f04adaf0c1 chore: added and updated TSDocs of order module service (#8246)
- Added/updated TSDocs of the order module's service type + other related types.
- Renamed parameter names that were inconsistent / had typos

Note: found some minor inconsistencies in some of the method signatures. Will open a separate PR to resolve them.

Closes DOCS-783
2024-08-06 07:18:31 +00:00
Shahed Nasser 98f42e8995 feat(create-medusa-app, medusa): check Node.js version before installation. (#8452)
Check before installation with `create-medusa-app` and `medusa new` whether the current node version is >= 20. If not, exit with an error.
2024-08-06 07:15:17 +00:00
Shahed Nasser caf1bfd23b docs: fixes to notification and file module guides (#8451) 2024-08-06 09:59:46 +03:00
Shahed Nasser 041019b319 docs: merge allOf in OAS to show all object types (#8453)
* docs: merge allOf in OAS to show all object types

* add case for non objects
2024-08-06 09:57:09 +03:00
Shahed Nasser a1f86fe415 chore(utils): add missing imports in notification TSDocs (#8447)
Add missing imports in the example snippet of the notification provider.
2024-08-05 11:15:55 +00:00
Shahed Nasser 2682e2e324 docs: fix sidebar not updating when api reference path changes (#8409) 2024-08-05 13:20:53 +03:00
Shahed Nasser 8eb538ff8f docs: added a section on sending requests to api routes in admin (#8412) 2024-08-05 13:20:34 +03:00
Shahed Nasser b37e976b9a chore(core-flows): add TSDocs to the emitEventStep (#8413) 2024-08-05 13:20:22 +03:00
Shahed Nasser e7965db071 docs: added a chapter on how to emit an event (#8414) 2024-08-05 11:39:47 +03:00
Shahed Nasser bb4f002d0a docs: fix node version in create-medusa-app reference (#8443)
* docs: fix node version in create-medusa-app reference

* change node version in cli reference
2024-08-05 11:10:55 +03:00
Shahed Nasser 4d99cd5e28 docs: fix recipes sidebar + homepage cards (#8415) 2024-08-02 16:31:17 +03:00
Shahed Nasser 58b405fac9 docs: added digital product recipe example (#8223)
- Added an example for the digital product recipe
- Fixes to the digital product recipe (overview)

Closes DOCS-792
2024-08-02 13:02:06 +00:00