diff --git a/README.md b/README.md index 47af44f44..48eb3ee5d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This repository is a starting point for creating new integrations for [Vue Store com/DivanteLtd/vue-storefront/tree/next). - [Demo]() (WIP) -- [Documentation](https://docs-next.vuestorefront.io/magento/) (WIP) +- [Documentation](https://docs-next.vuestorefront.io/guide/) (WIP) This repository is a monorepo containing three projects: diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index ab5e56803..3eaaafdba 100755 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,7 +1,7 @@ module.exports = { - title: 'Vue Storefront Next with Magento', + title: 'Vue Storefront 2 for Magento', base: '/', - description: 'Documentation for the Magento connector for Vue Storefront Next', + description: 'Documentation for the Magento connector for Vue Storefront 2', head: [ ['link', { rel: 'icon', href: '/favicon.png' }] ], @@ -21,38 +21,37 @@ module.exports = { })) }, themeConfig: { - logo: 'https://camo.githubusercontent.com/48c886ac0703e3a46bc0ec963e20f126337229fc/68747470733a2f2f643968687267346d6e767a6f772e636c6f756466726f6e742e6e65742f7777772e76756573746f726566726f6e742e696f2f32383062313964302d6c6f676f2d76735f3062793032633062793032633030303030302e6a7067', sidebar: [ { title: 'Essentials', collapsable: false, children: [ ['/', 'Introduction'], - ['/magento/getting-started', 'Getting started'], - ['/magento/configuration', 'Configuration'], + ['/guide/getting-started', 'Getting started'], + ['/guide/configuration', 'Configuration'], ] }, { title: 'Composables', collapsable: false, children: [ - ['/magento/composables/use-billing', 'useBilling'], - ['/magento/composables/use-cart', 'useCart'], - ['/magento/composables/use-category', 'useCategory'], - ['/magento/composables/use-checkout', 'useCheckout'], - ['/magento/composables/use-config', 'useConfig'], - ['/magento/composables/use-facet', 'useFacet'], - ['/magento/composables/use-make-oder', 'useMakeOrder'], - ['/magento/composables/use-page', 'usePage'], - ['/magento/composables/use-product', 'useProduct'], - ['/magento/composables/use-router', 'useRouter'], - ['/magento/composables/use-shipping', 'useShipping'], - ['/magento/composables/use-shipping-provider', 'useShippingProvider'], - ['/magento/composables/use-user', 'useUser'], - ['/magento/composables/use-user-billing', 'useUserBilling'], - ['/magento/composables/use-user-order', 'useUserOrder'], - ['/magento/composables/use-user-shipping', 'useUserShipping'], - ['/magento/composables/use-user-wishlist', 'useUserWishlist'] + ['/guide/composables/use-billing', 'useBilling'], + ['/guide/composables/use-cart', 'useCart'], + ['/guide/composables/use-category', 'useCategory'], + ['/guide/composables/use-checkout', 'useCheckout'], + ['/guide/composables/use-config', 'useConfig'], + ['/guide/composables/use-facet', 'useFacet'], + ['/guide/composables/use-make-oder', 'useMakeOrder'], + ['/guide/composables/use-page', 'usePage'], + ['/guide/composables/use-product', 'useProduct'], + ['/guide/composables/use-router', 'useRouter'], + ['/guide/composables/use-shipping', 'useShipping'], + ['/guide/composables/use-shipping-provider', 'useShippingProvider'], + ['/guide/composables/use-user', 'useUser'], + ['/guide/composables/use-user-billing', 'useUserBilling'], + ['/guide/composables/use-user-order', 'useUserOrder'], + ['/guide/composables/use-user-shipping', 'useUserShipping'], + ['/guide/composables/use-user-wishlist', 'useUserWishlist'] ] } ] diff --git a/docs/magento/composables/use-billing.md b/docs/guide/composables/use-billing.md similarity index 100% rename from docs/magento/composables/use-billing.md rename to docs/guide/composables/use-billing.md diff --git a/docs/magento/composables/use-cart.md b/docs/guide/composables/use-cart.md similarity index 100% rename from docs/magento/composables/use-cart.md rename to docs/guide/composables/use-cart.md diff --git a/docs/magento/composables/use-category.md b/docs/guide/composables/use-category.md similarity index 100% rename from docs/magento/composables/use-category.md rename to docs/guide/composables/use-category.md diff --git a/docs/magento/composables/use-checkout.md b/docs/guide/composables/use-checkout.md similarity index 100% rename from docs/magento/composables/use-checkout.md rename to docs/guide/composables/use-checkout.md diff --git a/docs/magento/composables/use-config.md b/docs/guide/composables/use-config.md similarity index 100% rename from docs/magento/composables/use-config.md rename to docs/guide/composables/use-config.md diff --git a/docs/magento/composables/use-facet.md b/docs/guide/composables/use-facet.md similarity index 100% rename from docs/magento/composables/use-facet.md rename to docs/guide/composables/use-facet.md diff --git a/docs/magento/composables/use-make-oder.md b/docs/guide/composables/use-make-oder.md similarity index 100% rename from docs/magento/composables/use-make-oder.md rename to docs/guide/composables/use-make-oder.md diff --git a/docs/magento/composables/use-page.md b/docs/guide/composables/use-page.md similarity index 100% rename from docs/magento/composables/use-page.md rename to docs/guide/composables/use-page.md diff --git a/docs/magento/composables/use-product.md b/docs/guide/composables/use-product.md similarity index 100% rename from docs/magento/composables/use-product.md rename to docs/guide/composables/use-product.md diff --git a/docs/magento/composables/use-router.md b/docs/guide/composables/use-router.md similarity index 100% rename from docs/magento/composables/use-router.md rename to docs/guide/composables/use-router.md diff --git a/docs/magento/composables/use-shipping-provider.md b/docs/guide/composables/use-shipping-provider.md similarity index 100% rename from docs/magento/composables/use-shipping-provider.md rename to docs/guide/composables/use-shipping-provider.md diff --git a/docs/magento/composables/use-shipping.md b/docs/guide/composables/use-shipping.md similarity index 100% rename from docs/magento/composables/use-shipping.md rename to docs/guide/composables/use-shipping.md diff --git a/docs/magento/composables/use-user-billing.md b/docs/guide/composables/use-user-billing.md similarity index 100% rename from docs/magento/composables/use-user-billing.md rename to docs/guide/composables/use-user-billing.md diff --git a/docs/magento/composables/use-user-order.md b/docs/guide/composables/use-user-order.md similarity index 100% rename from docs/magento/composables/use-user-order.md rename to docs/guide/composables/use-user-order.md diff --git a/docs/magento/composables/use-user-shipping.md b/docs/guide/composables/use-user-shipping.md similarity index 100% rename from docs/magento/composables/use-user-shipping.md rename to docs/guide/composables/use-user-shipping.md diff --git a/docs/magento/composables/use-user-wishlist.md b/docs/guide/composables/use-user-wishlist.md similarity index 100% rename from docs/magento/composables/use-user-wishlist.md rename to docs/guide/composables/use-user-wishlist.md diff --git a/docs/magento/composables/use-user.md b/docs/guide/composables/use-user.md similarity index 100% rename from docs/magento/composables/use-user.md rename to docs/guide/composables/use-user.md diff --git a/docs/magento/configuration.md b/docs/guide/configuration.md similarity index 100% rename from docs/magento/configuration.md rename to docs/guide/configuration.md diff --git a/docs/magento/getting-started.md b/docs/guide/getting-started.md similarity index 100% rename from docs/magento/getting-started.md rename to docs/guide/getting-started.md diff --git a/docs/magento/introduction.md b/docs/guide/introduction.md similarity index 100% rename from docs/magento/introduction.md rename to docs/guide/introduction.md diff --git a/docs/index.md b/docs/index.md index 5a5315b3f..a5e13ec72 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,5 @@ # Vue Storefront for Magento -This is a documentation for Vue Storefront integration with Magento 2. +This is a documentation for Vue Storefront 2 integration with Magento 2. -This Open Source integration is currently a **work in progress** and not ready for production usage. - -If you'd like to use Vue Storefront in production we suggest using the Enterprise version. [Contact us](https://www.vuestorefront.io/contact/sales) to learn more +This integration is currently a **Beta** and not ready for production usage. You can help us making the integration production-ready faster by reporting bugs and contributing to the code. \ No newline at end of file diff --git a/packages/api-client/package.json b/packages/api-client/package.json index 322cf2a78..0d39e967d 100644 --- a/packages/api-client/package.json +++ b/packages/api-client/package.json @@ -9,7 +9,7 @@ "build": "rm -rf lib && rollup -c", "dev": "rollup -c -w", "test": "cross-env APP_ENV=test jest --rootDir .", - "types": "typedoc --out ../../docs/magento/api-client --plugin typedoc-plugin-markdown src/index.ts" + "types": "typedoc --out ../../docs/guide/api-client --plugin typedoc-plugin-markdown src/index.ts" }, "dependencies": { "@vue-storefront/core": "^2.x",