From cbfe0a4e95605bdae9eb3cd413757988e85e0181 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 26 Sep 2025 16:18:35 +0300 Subject: [PATCH] docs: improve docs contribution guidelines (#13605) * docs: improve docs contribution guidelines * fix build error * fix build errors * fix build * fix build --- www/apps/api-reference/.env.sample | 13 ++- www/apps/book/.env.sample | 15 ++- .../contribution-guidelines/docs/page.mdx | 91 ++++++++++++++--- www/apps/book/generated/edit-dates.mjs | 2 +- www/apps/book/public/llms-full.txt | 98 ++++++++++++++++--- www/apps/cloud/.env.example | 13 ++- www/apps/resources/.env.sample | 13 ++- .../guides/storefront-returns/page.mdx | 2 +- www/apps/ui/.env.example | 13 ++- www/apps/user-guide/.env.example | 13 ++- 10 files changed, 221 insertions(+), 52 deletions(-) diff --git a/www/apps/api-reference/.env.sample b/www/apps/api-reference/.env.sample index 91bf73b126..491a00d104 100644 --- a/www/apps/api-reference/.env.sample +++ b/www/apps/api-reference/.env.sample @@ -1,11 +1,17 @@ +# ESSENTIAL FOR DEV +NEXT_PUBLIC_BASE_PATH=/api +NEXT_PUBLIC_ENV=development # change to production when running npm start +NEXT_PUBLIC_BASE_URL=http://localhost:3000 + +# OPTIONAL FOR DEV +ANALYZE_BUNDLE= + +# REQUIRED FOR PROD NEXT_PUBLIC_SEGMENT_API_KEY= -NEXT_PUBLIC_BASE_PATH= NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_ALGOLIA_API_KEY= NEXT_PUBLIC_ALGOLIA_APP_ID= -NEXT_PUBLIC_ENV=development # change to production when running npm start -NEXT_PUBLIC_BASE_URL= NEXT_PUBLIC_DOCS_URL= NEXT_PUBLIC_UI_URL= NEXT_PUBLIC_RESOURCES_URL= @@ -14,7 +20,6 @@ NEXT_PUBLIC_CLOUD_URL= NEXT_PUBLIC_DOCS_V1_URL= NEXT_PUBLIC_API_V1_URL= ALGOLIA_WRITE_API_KEY= -ANALYZE_BUNDLE= NEXT_PUBLIC_INTEGRATION_ID= NEXT_PUBLIC_GA_ID= NEXT_PUBLIC_REO_DEV_CLIENT_ID= \ No newline at end of file diff --git a/www/apps/book/.env.sample b/www/apps/book/.env.sample index 81c896a146..b9f04801a1 100644 --- a/www/apps/book/.env.sample +++ b/www/apps/book/.env.sample @@ -1,10 +1,18 @@ +# ESSENTIAL FOR DEV +NEXT_PUBLIC_ENV=development +NEXT_PUBLIC_BASE_URL=http://localhost:3000 +NEXT_PUBLIC_BASE_PATH= # should be left empty +NEXT_PUBLIC_PROD_BASE_URL=https://docs.medusajs.com # required for generating llms files + +# OPTIONAL FOR DEV +ANALYZE_BUNDLE= + +# REQUIRED FOR PROD NEXT_PUBLIC_SEGMENT_API_KEY= NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_ALGOLIA_API_KEY= NEXT_PUBLIC_ALGOLIA_APP_ID= -NEXT_PUBLIC_ENV= -NEXT_PUBLIC_BASE_URL= NEXT_PUBLIC_RESOURCES_URL= NEXT_PUBLIC_USER_GUIDE_URL= NEXT_PUBLIC_CLOUD_URL= @@ -12,11 +20,8 @@ NEXT_PUBLIC_UI_URL= NEXT_PUBLIC_API_URL= NEXT_PUBLIC_DOCS_V1_URL= ALGOLIA_WRITE_API_KEY= -ANALYZE_BUNDLE= CLOUDINARY_CLOUD_NAME= -NEXT_PUBLIC_BASE_PATH= NEXT_PUBLIC_GA_ID= -NEXT_PUBLIC_PROD_BASE_URL= NEXT_PUBLIC_INTEGRATION_ID= NEXT_MCP_SERVER_URL= NEXT_PUBLIC_REO_DEV_CLIENT_ID= \ No newline at end of file diff --git a/www/apps/book/app/learn/resources/contribution-guidelines/docs/page.mdx b/www/apps/book/app/learn/resources/contribution-guidelines/docs/page.mdx index eb16f35f3c..b6b9337a6c 100644 --- a/www/apps/book/app/learn/resources/contribution-guidelines/docs/page.mdx +++ b/www/apps/book/app/learn/resources/contribution-guidelines/docs/page.mdx @@ -10,6 +10,12 @@ Thank you for your interest in contributing to the documentation! You will be he +Making a quick fix to a page's content? You can scroll down to the bottom of the page and click on the "Edit this page" link to make quick edits directly in GitHub. If you're making bigger changes, such as adding a new page or making changes to the codebase, check out the rest of this guide. + + + + + This guide is specific to contributing to the documentation. If you’re interested in contributing to Medusa’s codebase, check out the [contributing guidelines in the Medusa GitHub repository](https://github.com/medusajs/medusa/blob/develop/CONTRIBUTING.md). @@ -31,11 +37,13 @@ Medusa's documentation projects are all part of the documentation `yarn` workspa The workspace has the following two directories: -- `apps`: this directory holds the different documentation websites and projects. - - `book`: includes the codebase for the [main Medusa documentation](https://docs.medusajs.com/). It's built with [Next.js 15](https://nextjs.org/). - - `resources`: includes the codebase for the resources documentation, which powers different sections of the docs such as the [Integrations](!resources!/integrations) or [How-to & Tutorials](!resources!/how-to-tutorials) sections. It's built with [Next.js 15](https://nextjs.org/). - - `api-reference`: includes the codebase for the API reference website. It's built with [Next.js 15](https://nextjs.org/). - - `ui`: includes the codebase for the Medusa UI documentation website. It's built with [Next.js 15](https://nextjs.org/). +- `apps`: this directory holds the different documentation websites and projects. All projects are built with [Next.js 15](https://nextjs.org/). + - `book`: includes the codebase and content for the [main Medusa documentation](../../../page.mdx). + - `resources`: includes the codebase and content for the resources documentation, which powers different sections of the docs such as the [Integrations](!resources!/integrations) or [How-to & Tutorials](!resources!/how-to-tutorials) sections. + - `api-reference`: includes the codebase and content for the [API reference](!api!/store). + - `ui`: includes the codebase and content for the [Medusa UI documentation](!ui!). + - `user-guide`: includes the codebase and content for the [user guide documentation](!user-guide!). + - `cloud`: includes the codebase and content for the [Medusa Cloud documentation](!cloud!). - `packages`: this directory holds the shared packages and components necessary for the development of the projects in the `apps` directory. - `docs-ui` includes the shared React components between the different apps. - `remark-rehype-plugins` includes Remark and Rehype plugins used by the documentation projects. @@ -104,6 +112,53 @@ The UI documentation also shows code examples, which are under the `www/apps/ui/ The UI component props are generated from the source code and placed into the `www/apps/ui/specs/components` directory. To contribute to these props and their comments, check the comments in the source code under the `packages/design-system/ui` directory. +### Medusa User Guide + +The content of all pages under the `/user-guide` path are under the `www/apps/user-guide/app` directory. + +### Medusa Cloud Docs + +The content of all pages under the `/cloud` path are under the `www/apps/cloud/app` directory. + +--- + +## Run Documentation Projects Locally + +To run a documentation project locally, such as `book` or `resources`, change into the directory of that project. + +Then, copy the `.env.example` file to a new `.env.local` file. This should sufficiently set up the environment variables needed to run the project. + +Finally, run the `dev` command to start the development server. For example, in the `book` project: + +```bash npm2yarn +npm run dev +``` + +You can then access the documentation site by going to the following URLs in your browser: + +- `book`: `http://localhost:3000` +- `resources`: `http://localhost:3000/resources` +- `api-reference`: `http://localhost:3000/api` (Store API routes at `/api/store` and Admin API routes at `/api/admin`) +- `ui`: `http://localhost:3000/ui` +- `user-guide`: `http://localhost:3000/user-guide` +- `cloud`: `http://localhost:3000/cloud` + + + +When you access the documentation site, you might see errors or warning messages related to missing environment variables of services like Algolia. You can ignore these errors and warnings when working locally. + + + +### Prep Command + +Each documentation project has a `prep` command that runs scripts to prepare data useful for development or production. + +The common task that `prep` does is generate the sidebar files, which is useful for both development and production. If you make changes to sidebar items, make sure to run the `prep` command before starting the development server. + +```bash npm2yarn +npm run prep +``` + --- ## Style Guide @@ -114,9 +169,9 @@ When you contribute to the documentation content, make sure to follow the [docum ## How to Contribute -If you’re fixing errors in an existing documentation page, you can scroll down to the end of the page and click on the “Edit this page” link. You’ll be redirected to the GitHub edit form of that page and you can make edits directly and submit a pull request (PR). +If you’re fixing small errors in an existing documentation page, you can scroll down to the end of the page and click on the “Edit this page” link. You’ll be redirected to the GitHub edit form of that page and you can make edits directly and submit a pull request (PR). -If you’re adding a new page or contributing to the codebase, fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done, create a PR in the Medusa repository. +If you’re adding a new page or contributing to the codebase, fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done, create a PR in the Medusa repository. ### Base Branch @@ -132,13 +187,27 @@ Make sure that the branch name starts with `docs/`. For example, `docs/fix-servi When you create a pull request, prefix the title with `docs:` or `docs(PROJECT_NAME):`, where `PROJECT_NAME` is the name of the documentation project this pull request pertains to. For example, `docs(ui): fix titles`. -In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) with the issue number. For example, “Closes #1333”. +In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) with the issue number. For example, `Closes #1333`. + +#### Prep Command Before PR + +If you made changes to the content of any documentation project, you must run the [prep](#prep-command) command in the `book` project before creating a pull request. It will generate the `llms-full.txt` file with the updated content. You should also run it in the project you made changes to, as that will generate other necessary files for the project, such as edit dates. + +```bash npm2yarn title="www/apps/book" +npm run prep +``` + + + +Some files are ignored by the script. So, if you don't see that the `llms-full.txt` file is updated after running the `prep` command, you can safely ignore it. + + --- ## Images -If you are adding images to a documentation page, you can host the image on [Imgur](https://imgur.com) for free to include it in the PR. Our team will later upload it to our image hosting. +If you are adding images to a documentation page, you can host the image on [Imgur](https://imgur.com) for free to include it in the PR. Our team will later upload it to our image hosting CDN. --- @@ -244,7 +313,7 @@ If you want to check content ESLint errors locally and fix them, you can do that yarn install ``` -2\. Run the turbo command in the `www` directory: +2\. Run the turbo command in the `www` directory or the specific documentation's directory (for example, `www/apps/book`): ```bash turbo run lint:content @@ -264,7 +333,7 @@ If you want to check code ESLint errors locally and fix them, you can do that by yarn install ``` -2\. Run the turbo command in the `www` directory: +2\. Run the turbo command in the `www` directory or the specific documentation's directory (for example, `www/apps/book`): ```bash yarn lint diff --git a/www/apps/book/generated/edit-dates.mjs b/www/apps/book/generated/edit-dates.mjs index 9ee79b8782..ccb9cc4157 100644 --- a/www/apps/book/generated/edit-dates.mjs +++ b/www/apps/book/generated/edit-dates.mjs @@ -109,7 +109,7 @@ export const generatedEditDates = { "app/learn/fundamentals/api-routes/parse-body/page.mdx": "2025-08-20T09:58:37.704Z", "app/learn/fundamentals/admin/routing/page.mdx": "2025-07-25T07:35:18.038Z", "app/learn/resources/contribution-guidelines/admin-translations/page.mdx": "2025-02-11T16:57:46.726Z", - "app/learn/resources/contribution-guidelines/docs/page.mdx": "2025-08-20T06:41:30.822Z", + "app/learn/resources/contribution-guidelines/docs/page.mdx": "2025-09-26T12:22:07.615Z", "app/learn/resources/usage/page.mdx": "2025-02-26T13:35:34.824Z", "app/learn/configurations/medusa-config/page.mdx": "2025-09-02T08:09:21.283Z", "app/learn/configurations/ts-aliases/page.mdx": "2025-07-23T15:32:18.008Z", diff --git a/www/apps/book/public/llms-full.txt b/www/apps/book/public/llms-full.txt index 4b3d3ac663..8fd8f6f552 100644 --- a/www/apps/book/public/llms-full.txt +++ b/www/apps/book/public/llms-full.txt @@ -23615,6 +23615,8 @@ Our team will perform a general review on your PR and merge it if no issues are Thank you for your interest in contributing to the documentation! You will be helping the open source community and other developers interested in learning more about Medusa and using it. +Making a quick fix to a page's content? You can scroll down to the bottom of the page and click on the "Edit this page" link to make quick edits directly in GitHub. If you're making bigger changes, such as adding a new page or making changes to the codebase, check out the rest of this guide. + This guide is specific to contributing to the documentation. If you’re interested in contributing to Medusa’s codebase, check out the [contributing guidelines in the Medusa GitHub repository](https://github.com/medusajs/medusa/blob/develop/CONTRIBUTING.md). ## What Can You Contribute? @@ -23634,11 +23636,13 @@ Medusa's documentation projects are all part of the documentation `yarn` workspa The workspace has the following two directories: -- `apps`: this directory holds the different documentation websites and projects. - - `book`: includes the codebase for the [main Medusa documentation](https://docs.medusajs.com//index.html.md). It's built with [Next.js 15](https://nextjs.org/). - - `resources`: includes the codebase for the resources documentation, which powers different sections of the docs such as the [Integrations](https://docs.medusajs.com/resources/integrations/index.html.md) or [How-to & Tutorials](https://docs.medusajs.com/resources/how-to-tutorials/index.html.md) sections. It's built with [Next.js 15](https://nextjs.org/). - - `api-reference`: includes the codebase for the API reference website. It's built with [Next.js 15](https://nextjs.org/). - - `ui`: includes the codebase for the Medusa UI documentation website. It's built with [Next.js 15](https://nextjs.org/). +- `apps`: this directory holds the different documentation websites and projects. All projects are built with [Next.js 15](https://nextjs.org/). + - `book`: includes the codebase and content for the [main Medusa documentation](https://docs.medusajs.com/learn/index.html.md). + - `resources`: includes the codebase and content for the resources documentation, which powers different sections of the docs such as the [Integrations](https://docs.medusajs.com/resources/integrations/index.html.md) or [How-to & Tutorials](https://docs.medusajs.com/resources/how-to-tutorials/index.html.md) sections. + - `api-reference`: includes the codebase and content for the [API reference](https://docs.medusajs.com/api-reference/api/store). + - `ui`: includes the codebase and content for the [Medusa UI documentation](https://docs.medusajs.com/ui/index.html.md). + - `user-guide`: includes the codebase and content for the [user guide documentation](https://docs.medusajs.com/user-guide/index.html.md). + - `cloud`: includes the codebase and content for the [Medusa Cloud documentation](https://docs.medusajs.com/cloud/index.html.md). - `packages`: this directory holds the shared packages and components necessary for the development of the projects in the `apps` directory. - `docs-ui` includes the shared React components between the different apps. - `remark-rehype-plugins` includes Remark and Rehype plugins used by the documentation projects. @@ -23695,6 +23699,49 @@ The UI documentation also shows code examples, which are under the `www/apps/ui/ The UI component props are generated from the source code and placed into the `www/apps/ui/specs/components` directory. To contribute to these props and their comments, check the comments in the source code under the `packages/design-system/ui` directory. +### Medusa User Guide + +The content of all pages under the `/user-guide` path are under the `www/apps/user-guide/app` directory. + +### Medusa Cloud Docs + +The content of all pages under the `/cloud` path are under the `www/apps/cloud/app` directory. + +*** + +## Run Documentation Projects Locally + +To run a documentation project locally, such as `book` or `resources`, change into the directory of that project. + +Then, copy the `.env.example` file to a new `.env.local` file. This should sufficiently set up the environment variables needed to run the project. + +Finally, run the `dev` command to start the development server. For example, in the `book` project: + +```bash npm2yarn +npm run dev +``` + +You can then access the documentation site by going to the following URLs in your browser: + +- `book`: `http://localhost:3000` +- `resources`: `http://localhost:3000/resources` +- `api-reference`: `http://localhost:3000/api` (Store API routes at `/api/store` and Admin API routes at `/api/admin`) +- `ui`: `http://localhost:3000/ui` +- `user-guide`: `http://localhost:3000/user-guide` +- `cloud`: `http://localhost:3000/cloud` + +When you access the documentation site, you might see errors or warning messages related to missing environment variables of services like Algolia. You can ignore these errors and warnings when working locally. + +### Prep Command + +Each documentation project has a `prep` command that runs scripts to prepare data useful for development or production. + +The common task that `prep` does is generate the sidebar files, which is useful for both development and production. If you make changes to sidebar items, make sure to run the `prep` command before starting the development server. + +```bash npm2yarn +npm run prep +``` + *** ## Style Guide @@ -23705,9 +23752,9 @@ When you contribute to the documentation content, make sure to follow the [docum ## How to Contribute -If you’re fixing errors in an existing documentation page, you can scroll down to the end of the page and click on the “Edit this page” link. You’ll be redirected to the GitHub edit form of that page and you can make edits directly and submit a pull request (PR). +If you’re fixing small errors in an existing documentation page, you can scroll down to the end of the page and click on the “Edit this page” link. You’ll be redirected to the GitHub edit form of that page and you can make edits directly and submit a pull request (PR). -If you’re adding a new page or contributing to the codebase, fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done, create a PR in the Medusa repository. +If you’re adding a new page or contributing to the codebase, fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done, create a PR in the Medusa repository. ### Base Branch @@ -23723,13 +23770,23 @@ Make sure that the branch name starts with `docs/`. For example, `docs/fix-servi When you create a pull request, prefix the title with `docs:` or `docs(PROJECT_NAME):`, where `PROJECT_NAME` is the name of the documentation project this pull request pertains to. For example, `docs(ui): fix titles`. -In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) with the issue number. For example, “Closes #1333”. +In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) with the issue number. For example, `Closes #1333`. + +#### Prep Command Before PR + +If you made changes to the content of any documentation project, you must run the [prep](#prep-command) command in the `book` project before creating a pull request. It will generate the `llms-full.txt` file with the updated content. You should also run it in the project you made changes to, as that will generate other necessary files for the project, such as edit dates. + +```bash npm2yarn title="www/apps/book" +npm run prep +``` + +Some files are ignored by the script. So, if you don't see that the `llms-full.txt` file is updated after running the `prep` command, you can safely ignore it. *** ## Images -If you are adding images to a documentation page, you can host the image on [Imgur](https://imgur.com) for free to include it in the PR. Our team will later upload it to our image hosting. +If you are adding images to a documentation page, you can host the image on [Imgur](https://imgur.com) for free to include it in the PR. Our team will later upload it to our image hosting CDN. *** @@ -23835,7 +23892,7 @@ If you want to check content ESLint errors locally and fix them, you can do that yarn install ``` -2\. Run the turbo command in the `www` directory: +2\. Run the turbo command in the `www` directory or the specific documentation's directory (for example, `www/apps/book`): ```bash turbo run lint:content @@ -23855,7 +23912,7 @@ If you want to check code ESLint errors locally and fix them, you can do that by yarn install ``` -2\. Run the turbo command in the `www` directory: +2\. Run the turbo command in the `www` directory or the specific documentation's directory (for example, `www/apps/book`): ```bash yarn lint @@ -97545,6 +97602,7 @@ export const createReturnRequest = async ( const orderId = formData.get("order_id") as string const items = JSON.parse(formData.get("items") as string) const returnShippingOptionId = formData.get("return_shipping_option_id") as string + const locationId = formData.get("location_id") as string if (!orderId || !items || !returnShippingOptionId) { return { @@ -97565,6 +97623,7 @@ export const createReturnRequest = async ( return_shipping: { option_id: returnShippingOptionId, }, + location_id: locationId }, headers, }) @@ -97581,7 +97640,7 @@ export const createReturnRequest = async ( } ``` -You add the `createReturnRequest` function. It sends a `POST` request to the `/store/returns` API route. The function accepts a `FormData` object containing the order ID, the items to be returned, and the selected return shipping option ID. +You add the `createReturnRequest` function. It sends a `POST` request to the `/store/returns` API route. The function accepts a `FormData` object containing the order ID, the items to be returned, the selected return shipping option ID, and the stock location ID to which the returned items will be sent. The function returns an object with the following properties: @@ -98220,6 +98279,9 @@ const ReturnRequestTemplate: React.FC = ({ formData.append("order_id", order.id) formData.append("items", JSON.stringify(selectedItems)) formData.append("return_shipping_option_id", selectedShippingOption) + // @ts-expect-error issue in HTTP types + const locationId = shippingOptions.find(opt => opt.id === selectedShippingOption)?.service_zone.fulfillment_set.location.id + formData.append("location_id", locationId) formAction(formData) } @@ -98564,7 +98626,7 @@ You can learn more about creating return reasons in the [Manage Return Reasons]( Next, you need to create a customer account from the Next.js Starter Storefront. To do that: 1. Go to Account. -2. Click the "Join us" link. +2. Click the `Join us` link. 3. Enter the customer's details like email and password. 4. Click "Join" to create the account. @@ -99025,6 +99087,14 @@ Download this reference as an OpenApi YAML file. You can import this file to too - [GET /admin/users/{id}](https://docs.medusajs.com/api/admin#users_getusersid) - [POST /admin/users/{id}](https://docs.medusajs.com/api/admin#users_postusersid) - [DELETE /admin/users/{id}](https://docs.medusajs.com/api/admin#users_deleteusersid) +- [GET /admin/views/{entity}/columns](https://docs.medusajs.com/api/admin#views_getviewsentitycolumns) +- [GET /admin/views/{entity}/configurations](https://docs.medusajs.com/api/admin#views_getviewsentityconfigurations) +- [POST /admin/views/{entity}/configurations](https://docs.medusajs.com/api/admin#views_postviewsentityconfigurations) +- [GET /admin/views/{entity}/configurations/active](https://docs.medusajs.com/api/admin#views_getviewsentityconfigurationsactive) +- [POST /admin/views/{entity}/configurations/active](https://docs.medusajs.com/api/admin#views_postviewsentityconfigurationsactive) +- [GET /admin/views/{entity}/configurations/{id}](https://docs.medusajs.com/api/admin#views_getviewsentityconfigurationsid) +- [POST /admin/views/{entity}/configurations/{id}](https://docs.medusajs.com/api/admin#views_postviewsentityconfigurationsid) +- [DELETE /admin/views/{entity}/configurations/{id}](https://docs.medusajs.com/api/admin#views_deleteviewsentityconfigurationsid) - [GET /admin/workflows-executions](https://docs.medusajs.com/api/admin#workflows-executions_getworkflowsexecutions) - [GET /admin/workflows-executions/{id}](https://docs.medusajs.com/api/admin#workflows-executions_getworkflowsexecutionsid) - [POST /admin/workflows-executions/{workflow_id}/run](https://docs.medusajs.com/api/admin#workflows-executions_postworkflowsexecutionsworkflow_idrun) @@ -125251,7 +125321,7 @@ By following this tutorial, you will learn how to: ![Diagram showing the architecture of the ticket booking system with Medusa](https://res.cloudinary.com/dza7lstvk/image/upload/v1757512301/Medusa%20Resources/ticket-booking-diagram_egbpye.jpg) -- [Full Code](https://github.com/medusajs/examples/tree/main/ticket-booking-system): Find the full code for this tutorial in this repository. +- [Full Code](https://github.com/medusajs/examples/tree/main/ticket-booking): Find the full code for this tutorial in this repository. - [OpenApi Specs for Postman](https://res.cloudinary.com/dza7lstvk/raw/upload/v1757423563/OpenApi/Ticket_Booking_System_iqq1k6.yaml): Import this OpenApi Specs file into tools like Postman. *** diff --git a/www/apps/cloud/.env.example b/www/apps/cloud/.env.example index d51fa7e024..6d9bfecb03 100644 --- a/www/apps/cloud/.env.example +++ b/www/apps/cloud/.env.example @@ -1,18 +1,23 @@ +# ESSENTIAL FOR DEV +NEXT_PUBLIC_ENV=development +NEXT_PUBLIC_BASE_URL=http://localhost:3000 +NEXT_PUBLIC_BASE_PATH=/cloud + +# OPTIONAL FOR DEV +ANALYZE_BUNDLE= + +# REQUIRED FOR PROD NEXT_PUBLIC_SEGMENT_API_KEY= NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_ALGOLIA_API_KEY= NEXT_PUBLIC_ALGOLIA_APP_ID= -NEXT_PUBLIC_ENV= -NEXT_PUBLIC_BASE_URL= -NEXT_PUBLIC_BASE_PATH= NEXT_PUBLIC_DOCS_URL= NEXT_PUBLIC_RESOURCES_URL= NEXT_PUBLIC_UI_URL= NEXT_PUBLIC_API_URL= NEXT_PUBLIC_USER_GUIDE_URL= ALGOLIA_WRITE_API_KEY= -ANALYZE_BUNDLE= CLOUDINARY_CLOUD_NAME= NEXT_PUBLIC_GA_ID= NEXT_PUBLIC_INTEGRATION_ID= diff --git a/www/apps/resources/.env.sample b/www/apps/resources/.env.sample index d00fcd8918..a34282e0af 100644 --- a/www/apps/resources/.env.sample +++ b/www/apps/resources/.env.sample @@ -1,11 +1,17 @@ +# ESSENTIAL FOR DEV +NEXT_PUBLIC_ENV=development +NEXT_PUBLIC_BASE_URL=http://localhost:3000 +NEXT_PUBLIC_BASE_PATH=/resources + +# OPTIONAL FOR DEV +ANALYZE_BUNDLE= + +# REQUIRED FOR PROD NEXT_PUBLIC_SEGMENT_API_KEY= NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_ALGOLIA_API_KEY= NEXT_PUBLIC_ALGOLIA_APP_ID= -NEXT_PUBLIC_ENV= -NEXT_PUBLIC_BASE_URL= -NEXT_PUBLIC_BASE_PATH= NEXT_PUBLIC_DOCS_URL= NEXT_PUBLIC_USER_GUIDE_URL= NEXT_PUBLIC_UI_URL= @@ -13,7 +19,6 @@ NEXT_PUBLIC_API_URL= NEXT_PUBLIC_CLOUD_URL= NEXT_PUBLIC_DOCS_V1_URL= ALGOLIA_WRITE_API_KEY= -ANALYZE_BUNDLE= NEXT_PUBLIC_AI_ASSISTANT_URL= NEXT_PUBLIC_AI_WEBSITE_ID= NEXT_PUBLIC_AI_API_ASSISTANT_RECAPTCHA_SITE_KEY= diff --git a/www/apps/resources/app/nextjs-starter/guides/storefront-returns/page.mdx b/www/apps/resources/app/nextjs-starter/guides/storefront-returns/page.mdx index 2ce85e4a2f..710fd8517d 100644 --- a/www/apps/resources/app/nextjs-starter/guides/storefront-returns/page.mdx +++ b/www/apps/resources/app/nextjs-starter/guides/storefront-returns/page.mdx @@ -1257,7 +1257,7 @@ You can learn more about creating return reasons in the [Manage Return Reasons]( Next, you need to create a customer account from the Next.js Starter Storefront. To do that: 1. Go to Account. -2. Click the "Join us" link. +2. Click the `Join us` link. 3. Enter the customer's details like email and password. 4. Click "Join" to create the account. diff --git a/www/apps/ui/.env.example b/www/apps/ui/.env.example index d51fa7e024..d9cda96239 100644 --- a/www/apps/ui/.env.example +++ b/www/apps/ui/.env.example @@ -1,18 +1,23 @@ +# ESSENTIAL FOR DEV +NEXT_PUBLIC_ENV=development +NEXT_PUBLIC_BASE_URL=http://localhost:3000 +NEXT_PUBLIC_BASE_PATH=/ui + +# OPTIONAL FOR DEV +ANALYZE_BUNDLE= + +# REQUIRED FOR PROD NEXT_PUBLIC_SEGMENT_API_KEY= NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_ALGOLIA_API_KEY= NEXT_PUBLIC_ALGOLIA_APP_ID= -NEXT_PUBLIC_ENV= -NEXT_PUBLIC_BASE_URL= -NEXT_PUBLIC_BASE_PATH= NEXT_PUBLIC_DOCS_URL= NEXT_PUBLIC_RESOURCES_URL= NEXT_PUBLIC_UI_URL= NEXT_PUBLIC_API_URL= NEXT_PUBLIC_USER_GUIDE_URL= ALGOLIA_WRITE_API_KEY= -ANALYZE_BUNDLE= CLOUDINARY_CLOUD_NAME= NEXT_PUBLIC_GA_ID= NEXT_PUBLIC_INTEGRATION_ID= diff --git a/www/apps/user-guide/.env.example b/www/apps/user-guide/.env.example index 6ed3a003a5..8a8a45af14 100644 --- a/www/apps/user-guide/.env.example +++ b/www/apps/user-guide/.env.example @@ -1,18 +1,23 @@ +# ESSENTIAL FOR DEV +NEXT_PUBLIC_ENV=development +NEXT_PUBLIC_BASE_URL=http://localhost:3000 +NEXT_PUBLIC_BASE_PATH=/user-guide + +# OPTIONAL FOR DEV +ANALYZE_BUNDLE= + +# REQUIRED FOR PROD NEXT_PUBLIC_SEGMENT_API_KEY= NEXT_PUBLIC_DOCS_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_API_ALGOLIA_INDEX_NAME= NEXT_PUBLIC_ALGOLIA_API_KEY= NEXT_PUBLIC_ALGOLIA_APP_ID= -NEXT_PUBLIC_ENV= -NEXT_PUBLIC_BASE_URL= -NEXT_PUBLIC_BASE_PATH= NEXT_PUBLIC_DOCS_URL= NEXT_PUBLIC_RESOURCES_URL= NEXT_PUBLIC_UI_URL= NEXT_PUBLIC_API_URL= NEXT_PUBLIC_CLOUD_URL= ALGOLIA_WRITE_API_KEY= -ANALYZE_BUNDLE= CLOUDINARY_CLOUD_NAME= NEXT_PUBLIC_GA_ID= NEXT_PUBLIC_INTEGRATION_ID=