Browse Source

chore(docs): Update sass dep, update top bar & getting started

Michael Bromley 2 years ago
parent
commit
84b11988ee

+ 3 - 6
docs/content/getting-started.md

@@ -7,13 +7,10 @@ weight: 0
 
 ## Requirements
  
-* [Node.js](https://nodejs.org/en/) **v14** or above, with support for **even-numbered Node.js versions**.
+* [Node.js](https://nodejs.org/en/) **v16** or above, with support for **even-numbered Node.js versions**.
 * The [supported TypeScript version](https://github.com/vendure-ecommerce/vendure/blob/master/packages/create/src/constants.ts#L7) is set upon installation. Upgrading to a newer version of TypeScript might result in compilation errors.
 * If you want to use MySQL, MariaDB, or Postgres as your data store, then you'll need an instance available locally. However, if you are just testing out Vendure, we recommend using SQLite, which has no external requirements.
-* For Windows users: make sure you have **[windows build tools](https://www.npmjs.com/package/windows-build-tools) installed**
-  * `npm install --global --production windows-build-tools`
-  * This step should be done with administrative rights, and is required because Vendure makes use of some dependencies which must be compiled upon installation.
- 
+
 ## Installation with @vendure/create
 
 The recommended way to get started with Vendure is by using the [@vendure/create](https://github.com/vendure-ecommerce/vendure/tree/master/packages/create) tool. This is a command-line tool which will scaffold and configure your new Vendure project and install all dependencies.
@@ -65,7 +62,7 @@ Assuming the default config settings, you can now access:
 * The Vendure Admin UI: [http://localhost:3000/admin](http://localhost:3000/admin)
 
 {{< alert primary >}}
-Log in with the superadmin credentials:
+Log in with the superadmin credentials you specified, which default to:
 
 * **username**: superadmin
 * **password**: superadmin

+ 13 - 0
docs/content/graphql-api/admin/_index.md

@@ -0,0 +1,13 @@
+---
+title: "Admin API"
+weight: 4
+showtoc: false
+---
+
+# GraphQL Admin API
+
+The Admin API is primarily used by the included Admin UI web app to perform administrative tasks such as inventory management, order tracking etc.
+
+{{% alert %}}
+Explore the interactive GraphQL Admin API at [demo.vendure.io/admin-api](https://demo.vendure.io/admin-api)
+{{< /alert >}}

+ 13 - 0
docs/content/graphql-api/shop/_index.md

@@ -0,0 +1,13 @@
+---
+title: "Shop API"
+weight: 3
+showtoc: false
+---
+
+# GraphQL Shop API
+
+The Shop API is used by storefront applications. It provides all the necessary queries and mutations for finding and viewing products, creating and updating orders, checking out, managing a customer account etc.
+
+{{% alert %}}
+Explore the interactive GraphQL Shop API at [demo.vendure.io/shop-api](https://demo.vendure.io/shop-api)
+{{< /alert >}}

+ 1 - 1
docs/data/build.json

@@ -1,4 +1,4 @@
 {
   "version": "2.0.0-beta.3",
-  "commit": "73fce94bf"
+  "commit": "d4d84fa76"
 }

+ 14 - 3
docs/layouts/partials/top-bar.html

@@ -13,9 +13,9 @@
     >
     `) }}
     <div class="max-w-screen-2xl mx-auto px-4 py-4 sm:px-6 md:pr-10">
-        <div class="flex justify-between items-center py-2 md:space-x-10">
+        <div class="flex justify-between items-center md:space-x-10">
             <div class="flex justify-start lg:w-0 lg:flex-1">
-                <a class="logo flex space-x-4 items-center" href="/" title="back to landing page">
+                <a class="logo flex space-x-4 items-center" href="https://vendure.io" title="back to landing page">
                     <div>
                         <img class="w-10" src="/logo.png" alt="Vendure logo" />
                     </div>
@@ -25,7 +25,18 @@
                     </div>
                 </a>
             </div>
-            <div class="flex text-gray-500"></div>
+            <div class="flex items-center space-x-4">
+                <a href="https://vendure.io/community" target="_blank" title="Join our Discord community!">
+                    <img src="/logo/discord-logo.png" class="w-6 h-6" alt="Discord logo" />
+                </a>
+                <a href="https://github.com/vendure-ecommerce/vendure" class="">
+                    <img
+                        class=""
+                        alt="GitHub star counter"
+                        src="https://img.shields.io/github/stars/vendure-ecommerce/vendure.svg?style=social"
+                    />
+                </a>
+            </div>
         </div>
     </div>
 </div>

+ 1 - 2
docs/package.json

@@ -21,8 +21,7 @@
     "css-loader": "^3.5.2",
     "fuzzy": "^0.1.3",
     "mini-css-extract-plugin": "^0.9.0",
-    "node-fetch": "^2.6.1",
-    "node-sass": "^6.0.1",
+    "node-sass": "^9.0.0",
     "postcss": "^8.2.10",
     "postcss-loader": "^4.2.0",
     "sass-loader": "^10.2.1",

File diff suppressed because it is too large
+ 338 - 257
docs/yarn.lock


Some files were not shown because too many files changed in this diff