Commit Graph

1145 Commits

Author SHA1 Message Date
Shahed Nasser
74b3385a65 chore(oas): [21/21] improve oas schemas (#9339)
* improve oas

* more improvements

* add missing descriptions

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-09-27 12:40:24 +02:00
Shahed Nasser
bd4d2fd554 docs-util: fixes following packages reorg (#9326)
- Typescript config aren't picked up properly anymore since they're moved to `_tsconfig.base.json` in the root. So, we now read the config from the config file.
- Update Typescript version in the `utils` monorepo to match that of the root monorepo
2024-09-26 17:22:08 +00:00
Shahed Nasser
229da19029 chore(oas): [20/n] improve oas schemas (#9337)
Improve oas schemas [20/n]
2024-09-26 17:21:07 +00:00
Shahed Nasser
be1adac024 chore(oas): [18/n] improve oas schemas (#9311)
Improve OAS schemas [18/n]
2024-09-26 14:08:10 +00:00
Shahed Nasser
af34bf6c0c chore(oas): [19/n] improve oas schemas (#9317)
- Improve OAS schemas [19/n]
- docs-generator: combine `Date | string` type to just `Date`.
2024-09-26 13:44:57 +00: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
c5bf22f3f4 chore(oas): [17/n] improve OAS schemas (#9284)
Improve OAS schemas [17/n]
2024-09-26 13:07:07 +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
97b72f4662 oas: [15/n] improve oas schemas (#9216)
Improve OAS schemas [15/n]

Note: validation error will be fixed once #9218 is merged
2024-09-26 13:03:41 +00:00
Shahed Nasser
d352ea8122 chore(oas): [16/n] improve oas schemas (#9272)
- Improve OAS schemas [16/n]
- fixes and improvements to docs-generator tool
2024-09-26 13:02:32 +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
github-actions[bot]
9480deb71d chore(docs): Generated References (#9314)
Generated the following references:
2024-09-26 06:41:01 +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
Adrien de Peretti
e096feb7d5 chore: Update modules deps (#9286) 2024-09-26 11:14:35 +05:30
github-actions[bot]
16d2fdbfe6 chore(docs): Generated References (#9293)
Generated the following references:
2024-09-25 12:23:18 +00:00
github-actions[bot]
657a9fb90b chore(docs): Generated References (#9267)
Generated the following references:
- `medusa`
- `modules`
- `modules_sdk`
- `payment_provider`
- `workflows`
2024-09-24 07:02:49 +00:00
Mohmmed Aqeeb
64c4c828b6 Fix: Install command for Vercel deployment documentation (#9270)
### What
Updated the Install Command in the Vercel deployment section to `npm install` instead of `npm run build`.

Closes #9264 

### Why
To ensure users have the correct installation instructions for deploying Medusa Admin on Vercel.

### How
Replaced the Install Command in the documentation.

### Testing
No formal testing was performed for this documentation update, as it addresses a minor typo.
2024-09-24 06:44:29 +00: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
github-actions[bot]
4a68bc1334 chore(docs): Generated References (#9232)
Generated the following references:
- `modules`
- `modules_sdk`
- `types`
2024-09-23 07:33:39 +00:00
Shahed Nasser
cebffc7a11 chore(oas): [13/n] improve oas schemas (#9201)
* chore(oas): [13/n] improve oas schemas

* remove tax region name
2024-09-22 14:50:26 +02: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
a4b5d66b3e docs: updates to digital product recipe (#9165)
- Create workflow for fulfilling digital products that sends a notification + create a shipment to mark the fulfillment as fulfilled / shipped.
- Update the subscriber handling the `digital_product_order.created` event to use the workflow
- Add section on using the local notification module provider for testing purposes.
2024-09-20 14:27:18 +00:00
Shahed Nasser
2f3d15de85 docs: fix attribute name in calculated price (#9215) 2024-09-20 17:22:35 +03:00
Shahed Nasser
6a2a105cf8 fix(oas): support additional props, fix circular references patch, and other fixes (#9213)
* chore(oas): support additional props, fix circular references patch, and other fixes

* fix description

* description fixes
2024-09-20 17:22:19 +03:00
github-actions[bot]
2cb9322ef5 chore(docs): Generated References (automated) (#9206)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-09-20 09:25:55 +02:00
Shahed Nasser
426c39c04b chore(oas): [14/n] improve OAS schemas (#9202)
* chore(oas): [14/n] improve OAS schemas

* fix description of required_quantity
2024-09-19 18:52:46 +02:00
Shahed Nasser
d6ce0688db chore(oas): [10/n] improve oas schemas (#9167)
* chore(oas): [10/n] improve oas schemas

* fix validation error

---------

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-09-19 18:51:55 +02:00
Shahed Nasser
4923a6e823 chore(oas): [12/n] improve oas schemas (#9200)
- improve OAS schemas [12/n]
- Support ignoring properties in type if it has the `@ignore` jsdoc tag.
2024-09-19 14:25:16 +00:00
Shahed Nasser
89928dfdf3 chore(oas): [11/n] improve oas schemas (#9188)
Improve OAS schemas [11/n]
2024-09-19 14:24:54 +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
github-actions[bot]
a00c2ddb31 chore(docs): Generated References (#9187)
Generated the following references:
- `modules`
2024-09-19 12:20:02 +00:00
github-actions[bot]
1c4d3f32cb chore(docs): Updated API Reference (v2) (#9174)
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>
2024-09-18 11:30:02 +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
github-actions[bot]
56ee4d6aad chore(docs): Updated API Reference (v2) (#9148)
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>
2024-09-18 07:13:51 +00:00
github-actions[bot]
a63f6910d0 chore(docs): Generated References (automated) (#9169)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
2024-09-18 08:07:01 +02:00
Shahed Nasser
d2c48228df chore(oas): [9/n] improve oas schemas (#9166) 2024-09-17 19:27:28 +02:00
Shahed Nasser
b5ffed6973 chore(oas): [7/n] improve oas schemas (#9162) 2024-09-17 19:27:20 +02:00
Shahed Nasser
78eaed70e5 chore(oas): [8/n] improve oas schemas (#9163)
Improve OAS schemas [8/n]
2024-09-17 17:26:41 +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
github-actions[bot]
175ca30f4f chore(docs): Generated References (#9153)
Generated the following references:
- `api_key`
- `auth`
- `auth_provider`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `customer_models`
- `dml`
- `file`
- `fulfillment`
- `fulfillment_provider`
- `inventory_next`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `payment_provider`
- `pricing`
- `product`
- `product_models`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`
2024-09-17 07:17:55 +00:00
Shahed Nasser
cb79a5dbff docs-util: fixes for circular references, PAK in examples, namespaces (#9091)
- Fix circular references in generated OAS comments by cloning objects
- Add publishable API key in the header of store cURL examples + change the admin authentication header to use bearer tokens.
- Add plugin to generate namespaces from the `@customNamespace` tag in TSDocs, this was available before but was removed.
- Other fixes related to re-using schemas, overwritten descriptions, and smaller fixes
2024-09-16 17:55:05 +00:00
Shahed Nasser
05c88268d3 oas: update authorization header in cURL examples (#9100) 2024-09-16 20:42:06 +03:00
Shahed Nasser
8d3fb7fb2b docs: use require instead of import in medusa-config.js (#9102)
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
2024-09-16 19:34:00 +02: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
35ffaf73d7 docs: update store cURL examples in OAS (#9099) 2024-09-16 15:37:11 +03:00