shopware · bojanrajh · Feb 21, 2024
diff --git a/packages/admin-sdk/DOCS.md b/packages/admin-sdk/DOCS.md
@@ -0,0 +1,40 @@
+# Docs
+
+An instance of the `shopware/developer-documentation-vitepress`, as is `shopware/developer-portal`, dedicated for
+Designers.
+
+## Develop
+
+Checkout `meteor` repository:
+
+```bash
+cd /www/
+git clone git@github.com:shopware/meteor.git
+cd /www/meteor
+```
+
+Prepare docs environment provided by the `developer-portal` repository. This will make sure the `developer-portal`
+repository is checked out and up to date.
+
+```bash
+pnpm docs:env
+```
+
+Symlink docs from your local `meteor` repository into the `developer-portal`.
+
+```bash
+pnpm docs:link
+```
+
+Run local webserver.
+
+```bash
+pnpm docs:preview
+```
+
+# Read more
+
+- [https://github.com/vuejs/vitepress](˙vuejs/vitepress˙) - SSR framework for the documentation
+- [https://github.com/shopware/developer-documentation-vitepress](˙shopware/developer-documentation-vitepress˙) -
+  Shopware specific config, design and components
+- [https://github.com/shopware/developer-portal](˙shopware/developer-portal˙) - Developer documentation
diff --git a/packages/admin-sdk/docs/.gitignore b/packages/admin-sdk/docs/.gitignore
diff --git a/packages/admin-sdk/docs/README.md b/packages/admin-sdk/docs/README.md
diff --git a/...reference/assets/notification-example.jpg → ...reference/assets/notification-example.jpg b/...reference/assets/notification-example.jpg → ...reference/assets/notification-example.jpg
diff --git a/...nce/assets/register-cms-block-example.png → ...nce/assets/register-cms-block-example.png b/...nce/assets/register-cms-block-example.png → ...nce/assets/register-cms-block-example.png
diff --git a/...e/assets/register-cms-element-example.png → ...e/assets/register-cms-element-example.png b/...e/assets/register-cms-element-example.png → ...e/assets/register-cms-element-example.png
diff --git a/...-reference/assets/useSharedState-demo.gif → ...-reference/assets/useSharedState-demo.gif b/...-reference/assets/useSharedState-demo.gif → ...-reference/assets/useSharedState-demo.gif
diff --git a/packages/admin-sdk/docs/api-reference/cms/index.md b/packages/admin-sdk/docs/api-reference/cms/index.md
@@ -0,0 +1,4 @@
+---
+nav:
+  position: 30
+---
diff --git a/...e/2_api-reference/cms/registerCmsBlock.md → ...ocs/api-reference/cms/registerCmsBlock.md b/...e/2_api-reference/cms/registerCmsBlock.md → ...ocs/api-reference/cms/registerCmsBlock.md
diff --git a/...2_api-reference/cms/registerCmsElement.md → ...s/api-reference/cms/registerCmsElement.md b/...2_api-reference/cms/registerCmsElement.md → ...s/api-reference/cms/registerCmsElement.md
diff --git a/packages/admin-sdk/docs/api-reference/composables/index.md b/packages/admin-sdk/docs/api-reference/composables/index.md
@@ -0,0 +1,5 @@
+---
+title: "Vue Composables"
+nav:
+  position: 40
+---
diff --git a/...i-reference/composables/useSharedState.md → ...i-reference/composables/useSharedState.md b/...i-reference/composables/useSharedState.md → ...i-reference/composables/useSharedState.md
diff --git a/...ocs/docs/guide/2_api-reference/context.md → ...s/admin-sdk/docs/api-reference/context.md b/...ocs/docs/guide/2_api-reference/context.md → ...s/admin-sdk/docs/api-reference/context.md
diff --git a/...cs/docs/guide/2_api-reference/data/get.md → .../admin-sdk/docs/api-reference/data/get.md b/...cs/docs/guide/2_api-reference/data/get.md → .../admin-sdk/docs/api-reference/data/get.md
@@ -1,7 +1,7 @@
 # Get
 
 With `data.get` you can receive datasets from the Shopware administration.
-More information on how to find the unique identifiers can be found in [this guide](../../5_internals/datahandling.md).
+More information on how to find the unique identifiers can be found in [this guide](../../internals/datahandling.md).
 
 Compared to data.subscribe, data.get only gives you the current state of the data. If the data is not available yet,
 such as when opening a page, you won't receive any data. In these cases, it's better to subscribe to data changes instead.

diff --git a/packages/admin-sdk/docs/api-reference/data/index.md b/packages/admin-sdk/docs/api-reference/data/index.md
@@ -0,0 +1,4 @@
+---
+nav:
+  position: 20
+---
diff --git a/.../guide/2_api-reference/data/repository.md → ...sdk/docs/api-reference/data/repository.md b/.../guide/2_api-reference/data/repository.md → ...sdk/docs/api-reference/data/repository.md
diff --git a/...s/guide/2_api-reference/data/subscribe.md → ...-sdk/docs/api-reference/data/subscribe.md b/...s/guide/2_api-reference/data/subscribe.md → ...-sdk/docs/api-reference/data/subscribe.md
@@ -1,7 +1,7 @@
 # Subscribe
 
 With `data.subscribe` you can subscribe to dataset changes. The callback will be called every time, the dataset with the matching id is changed. 
-More information on how to find the unique identifiers can be found in [this guide](../../5_internals/datahandling.md).
+More information on how to find the unique identifiers can be found in [this guide](../../internals/datahandling.md).
 
 #### Usage:  
 ```ts

diff --git a/...docs/guide/2_api-reference/data/update.md → ...min-sdk/docs/api-reference/data/update.md b/...docs/guide/2_api-reference/data/update.md → ...min-sdk/docs/api-reference/data/update.md
@@ -1,7 +1,7 @@
 # Update
 
 With `data.update` you can update datasets from the Shopware administration.
-More information on how to find the unique identifiers can be found in [this guide](../../5_internals/datahandling.md).
+More information on how to find the unique identifiers can be found in [this guide](../../internals/datahandling.md).
 
 #### Usage:  
 ```ts

diff --git a/packages/admin-sdk/docs/api-reference/index.md b/packages/admin-sdk/docs/api-reference/index.md
@@ -0,0 +1,4 @@
+---
+nav:
+  position: 20
+---
diff --git a/...cs/docs/guide/2_api-reference/location.md → .../admin-sdk/docs/api-reference/location.md b/...cs/docs/guide/2_api-reference/location.md → .../admin-sdk/docs/api-reference/location.md
@@ -1,7 +1,7 @@
 # Location
 
 ## Prerequisites
-We recommend you read the [concept](../4_concepts/locations.md) of locations first.
+We recommend you read the [concept](../concepts/locations.md) of locations first.
 ## Location checks
 
 ### Check the current location id
@@ -84,7 +84,7 @@ This method does not have a return value.
 
 This methods starts the auto resizer of the iFrame height.
 
-![Auto resizing example](../4_concepts/assets/auto-resizer.gif)
+![Auto resizing example](../concepts/assets/auto-resizer.gif)
 
 #### Usage:
 

diff --git a/...ocs/guide/2_api-reference/notification.md → ...in-sdk/docs/api-reference/notification.md b/...ocs/guide/2_api-reference/notification.md → ...in-sdk/docs/api-reference/notification.md
diff --git a/.../guide/2_api-reference/ui/actionButton.md → ...sdk/docs/api-reference/ui/actionButton.md b/.../guide/2_api-reference/ui/actionButton.md → ...sdk/docs/api-reference/ui/actionButton.md
diff --git a/...e/ui/assets/add-action-button-example.png → ...e/ui/assets/add-action-button-example.png b/...e/ui/assets/add-action-button-example.png → ...e/ui/assets/add-action-button-example.png
diff --git a/...nce/ui/assets/add-main-module-example.png → ...nce/ui/assets/add-main-module-example.png b/...nce/ui/assets/add-main-module-example.png → ...nce/ui/assets/add-main-module-example.png
diff --git a/...rence/ui/assets/add-menu-item-example.png → ...rence/ui/assets/add-menu-item-example.png b/...rence/ui/assets/add-menu-item-example.png → ...rence/ui/assets/add-menu-item-example.png
diff --git a/...ets/add-payment-overview-card-example.png → ...ets/add-payment-overview-card-example.png b/...ets/add-payment-overview-card-example.png → ...ets/add-payment-overview-card-example.png
diff --git a/...e/ui/assets/add-settings-item-example.png → ...e/ui/assets/add-settings-item-example.png b/...e/ui/assets/add-settings-item-example.png → ...e/ui/assets/add-settings-item-example.png
diff --git a/...erence/ui/assets/add-tab-item-example.png → ...erence/ui/assets/add-tab-item-example.png b/...erence/ui/assets/add-tab-item-example.png → ...erence/ui/assets/add-tab-item-example.png
diff --git a/...ence/ui/assets/example-card-with-tabs.png → ...ence/ui/assets/example-card-with-tabs.png b/...ence/ui/assets/example-card-with-tabs.png → ...ence/ui/assets/example-card-with-tabs.png
diff --git a/..._api-reference/ui/assets/example-card.png → .../api-reference/ui/assets/example-card.png b/..._api-reference/ui/assets/example-card.png → .../api-reference/ui/assets/example-card.png
diff --git a/...api-reference/ui/assets/modal-example.png → ...api-reference/ui/assets/modal-example.png b/...api-reference/ui/assets/modal-example.png → ...api-reference/ui/assets/modal-example.png
diff --git a/...e/2_api-reference/ui/component-section.md → ...ocs/api-reference/ui/component-section.md b/...e/2_api-reference/ui/component-section.md → ...ocs/api-reference/ui/component-section.md
diff --git a/packages/admin-sdk/docs/api-reference/ui/index.md b/packages/admin-sdk/docs/api-reference/ui/index.md
@@ -0,0 +1,5 @@
+---
+nav:
+  title: UI
+  position: 10
+---
diff --git a/...cs/guide/2_api-reference/ui/mainModule.md → ...n-sdk/docs/api-reference/ui/mainModule.md b/...cs/guide/2_api-reference/ui/mainModule.md → ...n-sdk/docs/api-reference/ui/mainModule.md
diff --git a/...docs/guide/2_api-reference/ui/menuItem.md → ...min-sdk/docs/api-reference/ui/menuItem.md b/...docs/guide/2_api-reference/ui/menuItem.md → ...min-sdk/docs/api-reference/ui/menuItem.md
diff --git a/...s/docs/guide/2_api-reference/ui/modals.md → ...admin-sdk/docs/api-reference/ui/modals.md b/...s/docs/guide/2_api-reference/ui/modals.md → ...admin-sdk/docs/api-reference/ui/modals.md
diff --git a/packages/admin-sdk/docs/api-reference/ui/module/index.md b/packages/admin-sdk/docs/api-reference/ui/module/index.md
@@ -0,0 +1,4 @@
+---
+nav:
+  title: Extending modules
+---
diff --git a/...eference/ui/module/paymentOverviewCard.md → ...eference/ui/module/paymentOverviewCard.md b/...eference/ui/module/paymentOverviewCard.md → ...eference/ui/module/paymentOverviewCard.md
diff --git a/.../guide/2_api-reference/ui/settingsItem.md → ...sdk/docs/api-reference/ui/settingsItem.md b/.../guide/2_api-reference/ui/settingsItem.md → ...sdk/docs/api-reference/ui/settingsItem.md
diff --git a/...ocs/docs/guide/2_api-reference/ui/tabs.md → ...s/admin-sdk/docs/api-reference/ui/tabs.md b/...ocs/docs/guide/2_api-reference/ui/tabs.md → ...s/admin-sdk/docs/api-reference/ui/tabs.md
diff --git a/...docs/docs/guide/2_api-reference/window.md → ...es/admin-sdk/docs/api-reference/window.md b/...docs/docs/guide/2_api-reference/window.md → ...es/admin-sdk/docs/api-reference/window.md
diff --git a/packages/admin-sdk/docs/babel.config.js b/packages/admin-sdk/docs/babel.config.js
diff --git a/.../guide/4_concepts/assets/auto-resizer.gif → ...sdk/docs/concepts/assets/auto-resizer.gif b/.../guide/4_concepts/assets/auto-resizer.gif → ...sdk/docs/concepts/assets/auto-resizer.gif
diff --git a/...pts/assets/component-sections-example.png → ...pts/assets/component-sections-example.png b/...pts/assets/component-sections-example.png → ...pts/assets/component-sections-example.png
diff --git a/.../component-sections-with-tabs-example.png → .../component-sections-with-tabs-example.png b/.../component-sections-with-tabs-example.png → .../component-sections-with-tabs-example.png
diff --git a/...cs/guide/4_concepts/component-sections.md → ...n-sdk/docs/concepts/component-sections.md b/...cs/guide/4_concepts/component-sections.md → ...n-sdk/docs/concepts/component-sections.md
diff --git a/packages/admin-sdk/docs/concepts/index.md b/packages/admin-sdk/docs/concepts/index.md
@@ -0,0 +1,4 @@
+---
+nav:
+  position: 40
+---
diff --git a/...k/docs/docs/guide/4_concepts/locations.md → ...ages/admin-sdk/docs/concepts/locations.md b/...k/docs/docs/guide/4_concepts/locations.md → ...ages/admin-sdk/docs/concepts/locations.md
diff --git a/...k/docs/docs/guide/4_concepts/positions.md → ...ages/admin-sdk/docs/concepts/positions.md b/...k/docs/docs/guide/4_concepts/positions.md → ...ages/admin-sdk/docs/concepts/positions.md
@@ -16,4 +16,4 @@ It is impossible to create a list of all potential position Id's. And they would
 
 Just open the plugin in the Devtools (It is available directly when you open the Administration). Then you can see all positions at the current administration view which are available for extending. If you click at one position Id you get more information about it. Like the property in the meteor-admin-sdk so that you directly know what functionality this position has.
 
-In summary: the Devtool plugin provides a visual way to see which parts can be extended and what are the positionIDs for the extension position. You can find a detailed guide in the tooling section of this documentation: [Vue Devtools](../3_tooling/vue-devtools.md)
+In summary: the Devtool plugin provides a visual way to see which parts can be extended and what are the positionIDs for the extension position. You can find a detailed guide in the tooling section of this documentation: [Vue Devtools](../tooling/vue-devtools.md)
diff --git a/...k/docs/docs/guide/4_concepts/selectors.md → ...ages/admin-sdk/docs/concepts/selectors.md b/...k/docs/docs/guide/4_concepts/selectors.md → ...ages/admin-sdk/docs/concepts/selectors.md
diff --git a/packages/admin-sdk/docs/docs/.gitkeep b/packages/admin-sdk/docs/docs/.gitkeep
diff --git a/packages/admin-sdk/docs/docs/guide/1_getting-started/_category_.yml b/packages/admin-sdk/docs/docs/guide/1_getting-started/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/2_api-reference/_category_.yml b/packages/admin-sdk/docs/docs/guide/2_api-reference/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/2_api-reference/cms/_category_.yml b/packages/admin-sdk/docs/docs/guide/2_api-reference/cms/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/2_api-reference/composables/_category_.yml b/packages/admin-sdk/docs/docs/guide/2_api-reference/composables/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/2_api-reference/data/_category_.yml b/packages/admin-sdk/docs/docs/guide/2_api-reference/data/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/2_api-reference/ui/_category_.yml b/packages/admin-sdk/docs/docs/guide/2_api-reference/ui/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/2_api-reference/ui/module/_category_.yml b/packages/admin-sdk/docs/docs/guide/2_api-reference/ui/module/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/3_tooling/_category_.yml b/packages/admin-sdk/docs/docs/guide/3_tooling/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/4_concepts/_category_.yml b/packages/admin-sdk/docs/docs/guide/4_concepts/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/5_internals/_category_.yml b/packages/admin-sdk/docs/docs/guide/5_internals/_category_.yml
diff --git a/packages/admin-sdk/docs/docs/guide/6_faq/_category_.yml b/packages/admin-sdk/docs/docs/guide/6_faq/_category_.yml
diff --git a/packages/admin-sdk/docs/docusaurus.config.js b/packages/admin-sdk/docs/docusaurus.config.js
diff --git a/.../admin-sdk/docs/docs/guide/6_faq/index.md → packages/admin-sdk/docs/faq/index.md b/.../admin-sdk/docs/docs/guide/6_faq/index.md → packages/admin-sdk/docs/faq/index.md
@@ -1,5 +1,7 @@
 ---
 title: "FAQ"
+nav:
+  position: 60
 ---
 
 # FAQ

diff --git a/...etting-started/assets/devtools-plugin.png → ...etting-started/assets/devtools-plugin.png b/...etting-started/assets/devtools-plugin.png → ...etting-started/assets/devtools-plugin.png
diff --git a/...getting-started/assets/devtools-usage.png → ...getting-started/assets/devtools-usage.png b/...getting-started/assets/devtools-usage.png → ...getting-started/assets/devtools-usage.png
diff --git a/.../docs/guide/1_getting-started/devTools.md → ...dmin-sdk/docs/getting-started/devTools.md b/.../docs/guide/1_getting-started/devTools.md → ...dmin-sdk/docs/getting-started/devTools.md
@@ -1,6 +1,6 @@
 ---
-title: "Vue dev tools"
-sidebar_position: 2
+nav:
+  position: 20
 ---
 
 # Vue dev tools

diff --git a/packages/admin-sdk/docs/getting-started/index.md b/packages/admin-sdk/docs/getting-started/index.md
@@ -0,0 +1,4 @@
+---
+nav:
+  position: 10
+---
diff --git a/...s/guide/1_getting-started/installation.md → ...-sdk/docs/getting-started/installation.md b/...s/guide/1_getting-started/installation.md → ...-sdk/docs/getting-started/installation.md
@@ -1,6 +1,6 @@
 ---
-title: "Installation"
-sidebar_position: 1
+nav:
+  position: 10
 ---
 
 # Installation

diff --git a/...ocs/docs/guide/1_getting-started/usage.md → ...s/admin-sdk/docs/getting-started/usage.md b/...ocs/docs/guide/1_getting-started/usage.md → ...s/admin-sdk/docs/getting-started/usage.md
@@ -1,5 +1,6 @@
 ---
-sidebar_position: 3
+nav:
+  position: 30
 ---
 
 # Usage