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 0357c71545..3664f7ba3c 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 @@ -1,3 +1,5 @@ +import { Prerequisites } from "docs-ui" + export const metadata = { title: `Docs Contribution Guidelines`, } @@ -25,7 +27,7 @@ You can contribute to the Medusa documentation in the following ways: ## Documentation Workspace -Medusa's documentation projects are all part of the documentation yarn workspace, which you can find in the [medusa repository](https://github.com/medusajs/medusa) under the `www` directory. +Medusa's documentation projects are all part of the documentation `yarn` workspace, which you can find in the [medusa repository](https://github.com/medusajs/medusa) under the `www` directory. The workspace has the following two directories: @@ -38,6 +40,35 @@ The workspace has the following two directories: - `docs-ui` includes the shared React components between the different apps. - `remark-rehype-plugins` includes Remark and Rehype plugins used by the documentation projects. +### Setup the Documentation Workspace + + + +In the `www` directory, run the following command to install the dependencies: + +```bash +yarn install +``` + +Then, run the following command to build packages under the `www/packages` directory: + +```bash +yarn build +``` + +After that, you can change into the directory of any documentation project under the `www/apps` directory and run the `dev` command to start the development server. + --- ## Documentation Content diff --git a/www/apps/book/generated/edit-dates.mjs b/www/apps/book/generated/edit-dates.mjs index de8e349463..4ea5949a5b 100644 --- a/www/apps/book/generated/edit-dates.mjs +++ b/www/apps/book/generated/edit-dates.mjs @@ -110,7 +110,7 @@ export const generatedEditDates = { "app/learn/fundamentals/api-routes/parse-body/page.mdx": "2025-04-17T08:29:10.145Z", "app/learn/fundamentals/admin/routing/page.mdx": "2025-02-24T09:50:37.495Z", "app/learn/resources/contribution-guidelines/admin-translations/page.mdx": "2025-02-11T16:57:46.726Z", - "app/learn/resources/contribution-guidelines/docs/page.mdx": "2025-03-06T09:32:26.010Z", + "app/learn/resources/contribution-guidelines/docs/page.mdx": "2025-05-26T15:55:02.974Z", "app/learn/resources/usage/page.mdx": "2025-02-26T13:35:34.824Z", "app/learn/configurations/medusa-config/page.mdx": "2025-04-17T08:29:09.907Z", "app/learn/configurations/ts-aliases/page.mdx": "2025-02-11T16:57:46.683Z",