Commit Graph

644 Commits

Author SHA1 Message Date
Shahed Nasser
bbc47dc5df docs: fix missing hooks property (#10008) 2024-11-12 09:53:12 +01:00
Shahed Nasser
713e428ec2 docs: fix cart completion in subscriptions recipe (#10021) 2024-11-11 20:37:26 +02:00
Shahed Nasser
a131a4468d docs: improve getting started chapters (#10014) 2024-11-11 20:35:57 +02:00
Shahed Nasser
5e1ccba06d docs: fix link to testing tools (#10030) 2024-11-11 18:24:55 +00:00
Shahed Nasser
c4183a5cb7 docs: improve transform docs (#10023) 2024-11-11 19:21:53 +01:00
github-actions[bot]
82fd93da17 chore(docs): Updated API Reference (automated) (#10017)
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>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-11-11 12:30:22 +00:00
github-actions[bot]
1cab15b209 chore(docs): Generated References (automated) (#10016)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `fulfillment`
- `inventory_next`
- `js_sdk`
- `modules`
- `modules_sdk`
- `order`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `types`
- `user`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-11-11 11:12:13 +00:00
Mohsen
a151865d0a Enhance Documentation for authenticate Middleware Function (#9898)
Clarified usage of allowUnauthenticated and allowUnregistered options, explaining their roles in controlling access for unauthenticated and unregistered users.
2024-11-11 10:06:05 +00:00
Shahed Nasser
94fb420434 docs: fix server worker mode in railway deployment (#9842)
* docs: fix server worker mode in railway deployment

* fix DISABLE_MEDUSA_ADMIN
2024-11-11 09:44:21 +01:00
github-actions[bot]
fc01ae68c0 chore(docs): Generated References (automated) (#9961)
Generated the following references:
- `api_key`
- `cart`
- `cart_models`
- `core_flows`
- `customer`
- `fulfillment`
- `inventory_next`
- `js_sdk`
- `medusa_config`
- `modules`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `stock_location_next`
- `tax`
- `tax_provider`
- `types`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-11-11 08:17:50 +00:00
Shahed Nasser
5d7c1ad655 docs: add more context and description to recipe steps (#9861) 2024-11-10 22:43:42 +01:00
Shahed Nasser
e94f35458c docs: add instructions on how to roll back a migration (#9870) 2024-11-10 22:43:31 +01:00
Shahed Nasser
c7b24eb3ec docs: remove upgrade guides doc (#9845) 2024-11-10 14:13:00 +01:00
Shahed Nasser
e229bea3c1 docs: fix resolve of custom file module guide (#9840)
Closes #9833
2024-11-10 07:33:07 +00:00
Shahed Nasser
d0d9bbcca9 docs: add common redirects to v1 docs (#9832)
Add common redirects to v1 docs that don't affect v2 docs
2024-11-10 07:32:44 +00:00
Harminder Virk
1a0882cc01 fix: commands to run from within the .medusa/server directory (#9941) 2024-11-07 14:12:54 +05:30
github-actions[bot]
242d00b567 chore(docs): Generated API Reference (automated) (#9962)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-11-07 09:14:58 +01:00
Shahed Nasser
37eeaa84a2 docs: small improvement to first customization guide (#9843)
Added a bit more context and what you'll build in the first customization guide and why it's powerful.

Closes DX-1044
2024-11-06 09:09:35 +00:00
0xflotus
7b51204ef3 fix(docs): small error (#9868)
* fix(docs): small error

* fix(docs): small typo error
2024-10-30 09:17:35 +01:00
Shahed Nasser
4d7cb54762 docs: add a note in 404 page about v1 docs (#9815) 2024-10-28 14:42:22 +01:00
Ratnadeep
c8d79c4ad4 docs : Update page.mdx referring (#9820)
Fix  The correct import is from "@medusajs/framework". referring to the issue #9810
2024-10-28 04:50:27 +00:00
Shahed Nasser
df5dc65e2a docs: added documentation on environment variables (#9798) 2024-10-26 14:35:38 +00:00
github-actions[bot]
c4cd2c2d7c chore(docs): Generated References (automated) (#9803)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-10-26 16:33:31 +02:00
github-actions[bot]
1c046a14ac chore(docs): Generated UI Reference (automated) (#9801)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-10-26 16:33:11 +02:00
Shahed Nasser
fd26839616 docs: fixes to ui docs (#9759) 2024-10-25 11:56:54 +03:00
Shahed Nasser
bf18d73ff4 docs: fix complete cart workflow usage in marketplace recipe (#9771)
- Fix usage of `completeCartWorkflow` which now returns an ID instead of the full order
- other: improvements in config across projects
2024-10-25 08:53:42 +00:00
github-actions[bot]
d40499ca6a chore(docs): Generated References (automated) (#9772)
Generated the following references:
- `auth_provider`
- `core_flows`
- `js_sdk`
- `medusa_config`
- `modules`
- `payment_provider`
- `tax`
- `tax_provider`
- `types`
- `workflows`

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-25 07:08:57 +00:00
Shahed Nasser
6617f81640 docs: add ui rewrite (#9762) 2024-10-24 14:02:55 +02:00
Shahed Nasser
88f2d17a24 docs: change configurations to make v2 the main docs (#9729)
* docs: change configurations to make v2 the main docs

* move api routes to top level

* remove api prefix

* update opengraph images

* show v1 link

* add redirect to v1
2024-10-24 14:49:58 +03:00
Shahed Nasser
5a1b6f0810 docs: fix deleteCascade typo (#9744) 2024-10-24 14:03:46 +03:00
Shahed Nasser
04cec64fa1 docs: show latest version in docs + update automatically (#9753) 2024-10-24 14:03:34 +03:00
Jack Caldwell
dec7d20b89 Update docs commerce modules so that tax links to the correct page (#9747)
### What

Update the href on the tax card on https://docs.medusajs.com/v2 to correctly link to https://docs.medusajs.com/v2/resources/commerce-modules/tax

### Why 

It is currently incorrectly linking to https://docs.medusajs.com/v2/resources/commerce-modules/stock-location

### How

Update the href value.

### Testing

To test open the docs page and verify that the link navigates to the correct page.
2024-10-24 09:50:01 +00:00
github-actions[bot]
f997432e73 chore(docs): Updated API Reference (automated) (#9728)
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>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:42:32 +00:00
github-actions[bot]
5deeae060a chore(docs): Generated References (automated) (#9727)
Generated the following references:
- `api_key`
- `auth`
- `cart`
- `core_flows`
- `currency`
- `customer`
- `dml`
- `fulfillment`
- `helper_steps`
- `inventory_next`
- `js_sdk`
- `medusa`
- `medusa_config`
- `modules`
- `modules_sdk`
- `notification`
- `order`
- `order_models`
- `payment`
- `pricing`
- `product`
- `promotion`
- `region`
- `sales_channel`
- `stock_location_next`
- `store`
- `tax`
- `tax_provider`
- `types`
- `user`
- `utils`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:41:14 +00:00
github-actions[bot]
e196ad7659 chore(docs): Updated UI Reference (automated) (#9726)
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>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:38:58 +00:00
Shahed Nasser
c08df5ac44 docs: remove dev notices + fix AI assistant answer width (#9686)
* docs: remove dev notices + fix AI assistant answer width

* fix import

* more notes removal

* rc to latest
2024-10-23 09:52:52 +02:00
Shahed Nasser
8891c0a3d0 docs: remove v1 docs from navbar (#9722)
* docs: remove v1 docs from navbar

* remove fallback
2024-10-23 09:10:27 +02:00
Shahed Nasser
f7932f11ed docs: fix details on setting / updating customer ID in cart (#9689) 2024-10-22 20:40:39 +03:00
Shahed Nasser
a1190b7208 docs: generate + configure js sdk reference (#9714)
Manually generate the JS SDK reference + add it to the sidebar
2024-10-22 17:31:32 +00:00
Shahed Nasser
3c0f0e2259 docs: small text fix (#9684) 2024-10-22 18:20:35 +03:00
Shahed Nasser
731309e87a docs: fixes following QA testing (#9690) 2024-10-22 18:20:21 +03:00
Shahed Nasser
b2122c4073 docs: fixes and refactoring for API reference (#9708)
* docs: fixes and refactoring for API reference

* add route caching

* remove caching

* use next cache
2024-10-22 18:20:06 +03:00
Sebastian Rindom
16e44688ba fix: revise words on docs intro page (#9588)
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-21 13:48:25 +00:00
Shahed Nasser
b4855825be docs: fix scroll + divider issues (#9663) 2024-10-21 09:54:05 +03:00
github-actions[bot]
8209d936a0 chore(docs): Updated API Reference (v2) (#9666)
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>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-18 17:14:26 +00:00
Shahed Nasser
61e6a07b55 docs: rename packages (#9618) 2024-10-18 14:43:46 +00:00
Shahed Nasser
85865c18ff docs: document JS SDK installation (#9611)
- Add a page introducing JS SDK + how to install and use it (generally)
- Adjust admin tips on how to send requests
- Adjust storefront tips to mention JS SDK
- Add in the API reference intro how to install JS SDK
- Other related additions / changes

Closes DX-957
2024-10-18 12:47:40 +00:00
Shahed Nasser
0a37675f0e docs: add routing page (#9550)
- Add a new homepage to `book` project for the routing page
- Move all main doc pages to be under `/v2/learn` (and added redirects + fixed links across docs)
- Other: add admin components to resources dropdown + fixes to search on mobile.

Closes DX-955

Preview: https://docs-v2-git-docs-router-page-medusajs.vercel.app/v2
2024-10-18 08:24:34 +00:00
Shahed Nasser
8fddabce04 docs: update curl request to /admin/products (#9641)
Closes DX-1026
2024-10-17 16:21:31 +00:00
Vraj Patel
7dbef9bedd fix(docs): update workflow API example to include query parameter (#9640)
### Fix Missing Query Parameter in Documentation Example

#### Summary
This pull request addresses a missing query parameter in the Medusa documentation's example for making a request to the workflow endpoint.

#### Issue
The example in the documentation incorrectly shows:
```
curl http://localhost:9000/workflow
```
This causes an issue when running the workflow in code, specifically in `step-2`, where the `name` parameter is `undefined`. 

#### Expected Behavior
The correct curl command should include the `name` query parameter, like so:
```
curl http://localhost:9000/workflow?name=john
```

#### Code Example
Here is the code that demonstrates the issue:

```ts
const step2 = createStep("step-2", async ({ name }: WorkflowInput) => {
  return new StepResponse(`Hello ${name} from step two!`)
})
```

When running the incorrect curl command, the output for `step-2` returns:
```
"Hello undefined from step two!"
```

#### Fix
The pull request proposes updating the example curl command in the documentation to:
```
curl http://localhost:9000/workflow?name=john
```

This ensures that the `name` parameter is correctly passed and resolves the issue of `undefined` values in `step-2`.

#### Steps to Reproduce
1. Implement the workflow and API code as described in the [documentation](https://docs.medusajs.com/v2/basics/workflows#4-test-workflow).
2. Run the curl command:
   ```
   curl http://localhost:9000/workflow
   ```
3. The console will output `Hello undefined from step two!` due to the missing `name` parameter.

#### Suggested Resolution
Update the curl command in the [documentation](https://docs.medusajs.com/v2/basics/workflows#4-test-workflow) to:
```
curl http://localhost:9000/workflow?name=john
```

### Related Issue
Link to the issue: [Medusa Issue #9628](https://github.com/medusajs/medusa/issues/9628)

Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
2024-10-17 14:51:43 +00:00