Commit Graph

160 Commits

Author SHA1 Message Date
Shahed Nasser
bbc47dc5df docs: fix missing hooks property (#10008) 2024-11-12 09:53:12 +01: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
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
e94f35458c docs: add instructions on how to roll back a migration (#9870) 2024-11-10 22:43:31 +01: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
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
Shahed Nasser
df5dc65e2a docs: added documentation on environment variables (#9798) 2024-10-26 14:35:38 +00: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
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]
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
731309e87a docs: fixes following QA testing (#9690) 2024-10-22 18:20:21 +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
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
Shahed Nasser
3610d58f49 docs: fix heroku typo (#9382)
Closes #9356
2024-10-16 10:44:50 +00:00
Shahed Nasser
6e856d3156 docs: added examples page (#9587)
- Added an examples page with examples of all different concepts in Medusa. We'll probably add more examples with time as we see the need for them.
- Small fixes in different pages.

Preview: https://resources-docs-ocb5uyp0o-medusajs.vercel.app/v2/resources/examples
2024-10-16 10:07:39 +00:00
Shahed Nasser
714b9e6c98 docs: update resolve path to use src (#9605)
Update path used in `resolve` of modules to start with `src`
2024-10-16 09:10:30 +00:00
Shahed Nasser
b6df24463d docs: updates for breaking changes (#9558)
- Update modules registration
- Update `medusa-config.js` to `medusa-config.ts`
- Update the out directory in the admin deployment guide
- Update logger imports
- Other fixes

Note: will need to re-generate references afterwards

Closes #9548
2024-10-14 10:40:30 +00:00
Shahed Nasser
74b286b701 docs: added documentation for admin components (#9491)
- Documented common admin components with design that matches the admin.
- Updated existing admin customization snippets to match the admin's design.

Closes DOCS-964
2024-10-14 07:18:38 +00:00
Shahed Nasser
e3dc9eaf0c docs: add guide on how to seed data (#9449)
Add a guide on how to seed data using a custom CLI script, with an example to seed products

Closes DOCS-953
2024-10-14 07:08:05 +00:00
Shahed Nasser
49a91fd40e docs: redesigned navigation (#9525)
Redesign navigation bar to reflect new design and allow for dropdowns

Closes DX-943
2024-10-11 07:10:00 +00:00
Shahed Nasser
f3c8f5efef docs: document using conditional operators in workflows (#9464) 2024-10-07 17:52:30 +00:00
Shahed Nasser
781d0ca624 docs: added docs for reset password (#9306)
- Added to docs on implementing auth flows using the module and API routes how to update a user's password
- Added guide on how to send a notification when a password token is generated
- Added a guide on implementing reset password flow in storefront
- Added OAS for the `/update` and `/reset-password` routes + generated specs for the API reference
2024-10-07 08:04:01 +00:00
Damien Thiesson
adb3a8246a docs: fix import path in the workflow basic documentation (#9481)
The import is three levels up, but, the `src/api/workflow/route.ts` file is only two levels down from `src/workflow`.

![Screenshot 2024-10-06 at 6 09 38 PM](https://github.com/user-attachments/assets/0d94338f-a8db-406b-80fe-a64ffe500ca3)
2024-10-07 07:22:15 +00:00
Shahed Nasser
ed174826a4 docs: update modules chapter in basics (#9452)
* docs: update modules chapter in basics

* address PR feedback
2024-10-04 14:15:41 +03:00
Shahed Nasser
00a51b59b1 docs: update imports of middlewares and http types (#9440) 2024-10-03 15:56:58 +00:00
Shahed Nasser
ab5a7ca691 docs: fix infinite scroll, update next.js, other fixes (#9441)
* update nextjs

* badge + scroll fixes
2024-10-03 14:17:33 +03:00
Shahed Nasser
0f6f56e764 docs: DX and performance improvements in API reference (#9430)
- Improve scroll behavior between active sections
- Improve lag when clicking on a sidebar item
- Refactor internal working of the `SidebarProvider` to find active items faster.
- Use Next.js's `useRouter` hook for changing the hash (since they added the option to disable scroll)
- Change `isBrowser` from a hook to a provider since it's widely used across applications.
- Other general improvements and fixes.

Closes DOCS-952
2024-10-02 15:51:02 +00:00
Shahed Nasser
9811da2960 docs: fix query option in instrumentation (#9395) 2024-10-02 10:29:11 +03:00
Shahed Nasser
8686ca9d12 docs: updates and fixes in utils + fulfillment provider changes (#9347)
* fix config + update deps

* rearrange sidebar + add to examples
2024-10-02 10:27:48 +03:00
Shahed Nasser
fb67d90b64 docs: improvements + additions to module docs (#9152)
- Split Module and Module Links to their own chapters
- Add new docs on db operations and transactions in modules, multiple services, links with custom columns, etc...
- Added a list of registered dependencies in a module container
2024-10-01 11:20:54 +00:00
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