Shahed Nasser
1ad7e7583f
docs: fix imports from dist ( #9401 )
2024-10-01 09:49:37 +00:00
arun-prasath2005
9bd99df545
Update page.mdx ( #9366 )
...
Spelling issue with perform, Fixed it!
2024-10-01 09:46:45 +00:00
Shahed Nasser
2e16949979
docs: update imports and package names across docs ( #9375 )
...
* docs: update imports and package names across docs
+ reference configs
* generate files
* fix import
* change preview to rc
2024-10-01 11:03:42 +02:00
Shahed Nasser
b3a204e974
docs: document InferTypeOf ( #9321 )
...
- Add documentation on how to use InferTypeOf
- Use InferTypeOf in recipes and examples
2024-09-26 13:42:29 +00:00
Shahed Nasser
39a6780815
docs: add note about authentication opt out ( #9298 )
...
Closes #9268
2024-09-26 13:04:27 +00:00
Shahed Nasser
ea2cc974cc
docs: fixes to customization docs ( #9236 )
...
Closes #9225 , #9224 , #9226 , #9227
Closes DOCS-948, DOCS-947, DOCS-945, DOCS-946
2024-09-26 13:00:37 +00:00
Shahed Nasser
2da15ba021
docs: added architecture documentation ( #9256 )
...
* docs: added architecture documentation
* update diagrams and text
* address PR comments
* sidebar + overview fixes
2024-09-26 09:29:47 +03:00
Mohmmed Aqeeb
3320f13f5a
Fix: Correct module path and clarify config structure in Medusa v2 Docs ( #9222 )
...
### What
This PR addresses an issue in the Medusa v2 documentation regarding the module creation example. The import paths were corrected to reflect the proper directory structure, ensuring clarity for users.
Closes #9220
### Why
The previous documentation contained incorrect import paths that could lead to confusion for users attempting to create and configure modules. Clarifying the structure aims to prevent similar issues for future users.
### How
- Updated the import statements in the documentation to go two levels up instead of three.
- Added clarification in the `medusa-config.js` example to indicate that the `modules` node should be a part of `projectConfig`.
### Testing
While documentation changes do not require formal testing, I reviewed the updated paths and descriptions against the current code structure to ensure accuracy and clarity.
### Note
This is my first contribution to an open source project, and I'm excited to contribute to the Medusa community!
2024-09-23 13:55:32 +00:00
Shahed Nasser
c790af7834
docs: improve search to show results for all filters ( #9208 )
...
* docs: improve search to show results for all filters
* fix index ordering
2024-09-22 14:49:16 +02:00
Shahed Nasser
138523a629
docs: change navbar items + breadcrumb improvements ( #9209 )
...
- Add a new commerce module navbar item
- Rename Learning Resources to Development Resources (in navbar and across documentation content)
- Improve breadcrumbs to show categories / subcategories
Preview: https://resources-docs-git-docs-navbar-changes-medusajs.vercel.app/v2/resources
2024-09-22 12:47:35 +00:00
Shahed Nasser
6584e911e0
docs: improvements + additions to workflow docs ( #9182 )
...
Improve existing workflow docs + add missing docs
2024-09-20 15:38:32 +00:00
Shahed Nasser
8dd72acee2
docs: add an examples list documentation ( #9194 )
2024-09-19 16:09:29 +02:00
Shahed Nasser
db73e9b972
docs: fix link in sidebar for modules test example ( #9195 )
2024-09-19 16:08:36 +02:00
Shahed Nasser
bf4335f2a6
docs: improvements and fixes to API route docs ( #9197 )
...
General improvements and fixes to docs around API routes
2024-09-19 14:08:23 +00:00
Shahed Nasser
0c3e3ea88a
docs: customization chapter exploration ( #9078 )
...
Adds a new customizations chapter with realistic example while maintaining the linear learning journey.
Preview: https://docs-v2-git-docs-customizations-chapter-medusajs.vercel.app/v2/customization
2024-09-18 08:45:29 +00:00
Shahed Nasser
cda5bbac78
docs: added documentation on instrumentation ( #9160 )
...
Added new documentation chapter on instrumentation and observability
2024-09-17 17:22:16 +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
0bcdcccbe2
docs: update query usage across docs ( #9120 )
...
WIP
2024-09-16 12:46:26 +00:00
Shahed Nasser
8584031041
docs: replace ModuleRegistrationName with Modules ( #9142 )
2024-09-16 15:30:03 +03:00
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 and Shahed Nasser
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