Commit Graph

162 Commits

Author SHA1 Message Date
Shahed Nasser
5f9029c033 docs: revise commerce modules (#10209) 2024-11-21 18:45:39 +02:00
Shahed Nasser
af374f85d1 docs: revise modules (#10204) 2024-11-21 18:37:59 +02:00
Shahed Nasser
ab5f2b5e11 docs: update og images (#10206)
* docs: update og images

* fixes
2024-11-21 17:33:50 +02:00
Mohsen
9e5e4c9f25 Set proper name for the steps in the schedule-task page (#9716)
Change `step` to `steps` for the batch workflows.
2024-11-21 14:14:57 +00:00
Shahed Nasser
35afa04a93 docs: migrate Kapa (#10198)
* docs: migrate kapa

* remove unused dependency

* fix isbrowser
2024-11-21 15:05:50 +02:00
Shahed Nasser
f541e21c62 docs: revise medusa container chapter (#10192) 2024-11-21 11:22:15 +02:00
Shahed Nasser
765f99e04b docs: fix font smoothing across projects (#10183) 2024-11-20 18:24:58 +02:00
Shahed Nasser
bef89e43c4 docs: revise intro pages (#10182) 2024-11-20 17:36:02 +02:00
Shahed Nasser
7a3c6acf31 docs: fix heading import in ui route docs (#10167) 2024-11-19 18:49:07 +02:00
Shahed Nasser
be700e31f2 docs: add section on querying records from a link's table (#10165) 2024-11-19 18:28:10 +02:00
Shahed Nasser
1fb2998620 docs: document nested UI routes (#10104)
* docs: document nested UI routes

* address PR feedback
2024-11-15 18:54:33 +02:00
Shahed Nasser
12e8405cca docs: add note about using dates in workflows (#10107) 2024-11-15 18:42:56 +02:00
Shahed Nasser
9c39cf69fb docs: add guide on how to translate admin (#10095)
* docs: add guide on how to translate admin

* added a link from the main docs
2024-11-14 17:17:01 +02:00
Shahed Nasser
938f3bd934 docs: update to next 15 + eslint 9 (#9839)
* update next

* updated react

* update eslint

* finish updating eslint

* fix content lint errors

* fix docs test

* fix vale action

* fix installation errors
2024-11-13 17:03:17 +02:00
Shahed Nasser
6f7467f071 docs: added + updated build and deployment guides (#10019) 2024-11-13 14:44:36 +02:00
Shahed Nasser
f151fb32aa docs: add emit events + types documentation (#10026)
* docs: add emit events + types documentation

* vale fixes
2024-11-13 14:17:14 +02:00
Shahed Nasser
7a26e123bb docs: fix outdated links (#10040) 2024-11-13 11:02:01 +02:00
Shahed Nasser
2d469ba587 docs: added note about test timeout (#10041) 2024-11-13 11:01:47 +02:00
Shahed Nasser
868b1c190f docs: change useRemoteQueryStep to useQueryGraphStep (#10051)
* docs: change useRemoteQueryStep to useQueryGraphStep

* fix lint errors
2024-11-13 11:00:55 +02:00
Shahed Nasser
823552ecd9 docs: document multiple steps usage in a workflow (#10053) 2024-11-13 11:00:37 +02:00
Shahed Nasser
3962c2c88f docs: fix link to medusa configuration guide (#10059) 2024-11-13 11:00:04 +02:00
Shahed Nasser
690c352993 docs: add documentation on validateAndTransformQuery (#10060)
* docs: add documentation on validateAndTransformQuery

* fix vale error
2024-11-13 10:59:46 +02:00
Mohsen
4f0726311a Fix grammar issue in the doc (#10064)
added "in" to fix a grammar issue
2024-11-13 07:57:06 +00:00
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
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
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
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
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
f3c8f5efef docs: document using conditional operators in workflows (#9464) 2024-10-07 17:52:30 +00:00