Commit Graph

97 Commits

Author SHA1 Message Date
Shahed Nasser
41fb2aacb0 docs: fixes to long-running workflows + relationship docs (#9101) 2024-09-12 09:51:00 +03:00
Shahed Nasser
1466ca73e0 docs: added a services constraint document (#8999)
- Added a services constraint document mentioning that a service's methods must be async.
- Modify the code in the services intro document to use `async` method.
2024-09-10 18:00:23 +00:00
Shahed Nasser
e9b5f76f9a docs: add Query documentation (#9079)
- Replace remote query documentation with new Query documentation
- Add redirect from old remote query to new query documentation
- Update remote query usages across docs to use new query usage.
2024-09-10 12:31:47 +00: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
c091cf5868 docs: add prerequisites link for test guides (#9057)
- Add a prerequisites link to test guides pointing to how to setup the testing tools
- Add in the main http / module integration guides the command to run the tests
2024-09-09 13:58:42 +00:00
Shahed Nasser
b5dbf572e3 docs: document star actor types (#9044) 2024-09-06 17:38:51 +02:00
Shahed Nasser
abe7b66999 docs: rename admin-shared -> admin-sdk (#9008) 2024-09-06 10:33:34 +02:00
Shahed Nasser
951b4a8100 docs: fixes to testing tool guides (#8981) 2024-09-04 18:24:49 +00:00
Shahed Nasser
1d54e8fdc1 docs: add new API route guides + fixes and improvements to existing ones (#8987)
- Add new documentation pages for API route intro, responses, errors, and validation
- General fixes and improvements across existing API route guides

> Note: I didn't work on the guide for additional data validation. Will work on this as part of my next focus on workflows.
2024-09-04 18:23:55 +00:00
Shahed Nasser
58f297cc75 docs: added documentation on testing tools (#8939)
- Added documentation on how to use Medusa's tools from the `medusa-test-utils` package to create integration and unit tests.
- Added a manual reference on the `medusaIntegrationTestRunner` and `moduleIntegrationTestRunner` functions. Since the typings in the source code aren't very informative, I opted for a manual reference shedding light on the important bits.

Closes DOCS-852
2024-09-03 14:50:45 +00:00
Shahed Nasser
e9fce4c5c2 docs: improvements to intro and basics chapters (#8956) 2024-09-03 17:34:07 +03:00
Shahed Nasser
46a70eaf5b docs: added a section on middlewares and trailing backslashes (#8942) 2024-09-03 17:32:36 +03:00
Shahed Nasser
f9b0605d67 docs: generate sitemaps + change search filters (#8957)
- Generate sitemaps for `book` and `resources` projects (in attempt to resolve some pages not being picked up by the crawler)
- Change the v2 search filters

> Note: will require changes to algolia's crawler + a recrawl once merged
2024-09-03 10:33:08 +00:00
Attila Turcsan
b9eac4402b Update page.mdx (#8908)
Fix API route path in the example.
2024-08-30 13:11:32 +00:00
Shahed Nasser
8c82207a41 docs: replace usages of migrations and links commands (#8894) 2024-08-30 11:48:49 +03:00
Shahed Nasser
59217a9796 docs: add a note about the middleware regular expression (#8742) 2024-08-27 10:35:43 +02:00
Shahed Nasser
5996089c9c docs: added new guides and troubleshooting related to admin development (#8739) 2024-08-27 10:35:09 +02:00
Ray Quijada
bb0fcbad7b docs(ui): update 3.4 Modules & Services v2 documentation (#8751)
* chore: update 3.4 Modules and Services v2 documentation

explicitly mentioned `service.ts` requirement in 3.4 guide from 3.6

Content from:
https://docs.medusajs.com/v2/basics/modules-directory-structure#servicets

* chore: add missing dot

---------

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-08-26 10:53:52 +03:00
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
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
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
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
c479fe8220 docs: added edit date (#8623) 2024-08-19 09:47:57 +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
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
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
705ea0ad33 docs: improve the workflow hooks guide (#8538)
* initial

* docs: improve workflow hook guides
2024-08-13 09:55:37 +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
8eb538ff8f docs: added a section on sending requests to api routes in admin (#8412) 2024-08-05 13:20:34 +03:00
Shahed Nasser
e7965db071 docs: added a chapter on how to emit an event (#8414) 2024-08-05 11:39:47 +03:00
Viktor Bakurin
be8afcaa63 docs: fix ModuleRegistrationName import (#8434)
Closes #8433
2024-08-05 07:24:27 +00:00
Viktor Bakurin
8cb416e661 docs: fix deployment link (#8431)
Closes #8430
2024-08-05 07:24:05 +00:00
Viktor Bakurin
ec0a68ec88 docs: fix helloWorldLoader function definition (#8429)
- Make helloWorldLoader async to follow the type definition

Closes #8428
2024-08-05 07:23:49 +00:00
Shahed Nasser
6f973d9f2b docs: added workflow hooks docs + changed workflow response (#8364)
* docs: added workflow hooks docs + changed workflow response

* Update page.mdx
2024-07-31 17:01:33 +03:00
Shahed Nasser
a4eab3f37a docs: added a service factory reference (#8292)
Added a service factory reference of the generated methods and how to use them.

Since the types in the codebase are a bit complex, a generated reference won't provide a valuable result.

Instead, this reference is created manually and aims to cover common use cases, providing examples for them.

Closes DOCS-844
2024-07-26 14:40:56 +00:00
Shahed Nasser
eb64ae75a6 docs: update middlewares to use defineMiddlewares (#8283) 2024-07-25 17:14:06 +02:00
Shahed Nasser
0c682b92c4 docs: updates to Medusa server deployment guides (#8268)
* updated railway deployment docs

* general updates and fixes
2024-07-25 09:55:22 +03:00
Shahed Nasser
0a482e972f docs: added a section to introduction on using docs (#8257)
Add a section to the introduction page explaining the different sections of the V2 docs and how / when to use them.
2024-07-24 14:16:33 +00:00
Shahed Nasser
ccc99b48a0 docs: add 404 page (#8260) 2024-07-24 17:07:30 +03:00
Shahed Nasser
774d04da48 docs: fix information related to link directions (#8236)
* docs: fix keys passed to remoteLink.create and remoteLink.dismiss

* updated hello module name + clarified note

* added details about module link directions

* fix lint errors
2024-07-24 09:16:01 +02:00
Shahed Nasser
97f64a5cfe docs: fix note about how method names are generated (#8240)
* docs: fix note about how method names are generated

* small fix
2024-07-23 18:28:34 +03:00
Shahed Nasser
a2d08eb635 docs: document links sync command (#8212)
* docs: document links sync command

* small wording fix

* sentence fix
2024-07-22 13:17:53 +03:00
Shahed Nasser
5def252e4b docs: add section on delete cascades (#8198)
* docs: add section on delete cascades

* small text fix
2024-07-21 21:21:36 +02:00
Shahed Nasser
2f56030101 docs: remove the requirement on is queryable (#8199) 2024-07-21 21:20:24 +02:00