docs: migrate UI docs (#13245)

* docs: create a new UI docs project (#13233)

* docs: create a new UI docs project

* fix installation errors

* docs: migrate UI docs content to new project (#13241)

* Fix content

* added examples for some components

* finish adding examples

* lint fix

* fix build errors

* delete empty files

* path fixes + refactor

* fix build error
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-08-20 11:42:25 +03:00
1 parent 5b7a041246
commit d1a1135328
748 files changed
+13079 -7319

No files matched your search

@@ -98,11 +98,11 @@ The API reference's content is split into two types:
### Medusa UI Documentation
The content of the Medusa UI documentation are located under the `www/apps/ui/src/content/docs` directory. They are MDX files.
The content of the Medusa UI documentation are located under the `www/apps/ui/app` directory. They are MDX files.
The UI documentation also shows code examples, which are under the `www/apps/ui/src/examples` directory.
The UI documentation also shows code examples, which are under the `www/apps/ui/specs/examples` directory.
The UI component props are generated from the source code and placed into the `www/apps/ui/src/specs` directory. To contribute to these props and their comments, check the comments in the source code under the `packages/design-system/ui` directory.
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.
---
@@ -195,7 +195,7 @@ cd www/vale
# to lint content for the API reference
./run-vale.sh api-reference/markdown error
# to lint content for the Medusa UI documentation
./run-vale.sh ui/src/content/docs error
./run-vale.sh ui/app error
# to lint content for the user guide
./run-vale.sh user-guide/app error
```
+1 -1
View File
@@ -109,7 +109,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-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-05-26T15:55:02.974Z",
"app/learn/resources/contribution-guidelines/docs/page.mdx": "2025-08-20T06:41:30.822Z",
"app/learn/resources/usage/page.mdx": "2025-02-26T13:35:34.824Z",
"app/learn/configurations/medusa-config/page.mdx": "2025-07-14T09:28:54.302Z",
"app/learn/configurations/ts-aliases/page.mdx": "2025-07-23T15:32:18.008Z",
-1
View File
@@ -31,7 +31,6 @@ const withMDX = mdx({
},
ui: {
projectPath: path.resolve("..", "ui"),
contentPath: "src/content/docs",
},
"user-guide": {
projectPath: path.resolve("..", "user-guide"),
File diff suppressed because it is too large. Load diff
+9 -3
View File
@@ -265,7 +265,7 @@ async function main() {
},
},
{
dir: path.join(process.cwd(), "..", "ui", "src", "content", "docs"),
dir: path.join(process.cwd(), "..", "ui", "app"),
options: {
parserOptions: {
ComponentExample: {
@@ -273,12 +273,18 @@ async function main() {
process.cwd(),
"..",
"ui",
"src",
"specs",
"examples"
),
},
ComponentReference: {
specsPath: path.join(process.cwd(), "..", "ui", "src", "specs"),
specsPath: path.join(
process.cwd(),
"..",
"ui",
"specs",
"components"
),
},
},
},