update docs

lerte · Apr 15, 2024 · 7f51290 · 7f51290
1 parent 36e849e
commit 7f51290
Show file tree

Hide file tree

Showing 28 changed files with 126 additions and 597 deletions.
diff --git a/docs/docs/enable.md b/docs/docs/enable.md
@@ -0,0 +1,13 @@
+---
+sidebar_position: 3
+---
+
+### Copy your Enable Your Environment from zrok dashboard.
+
+![zroker enable](./img/enable-environment.png)
+
+### Paste the code to this app, then click **Enalbe** button.
+
+![zroker enable](./img/enable.png)
+
+### After enabled successfully, you will see the [overview](/docs/overview)
diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md
@@ -0,0 +1,13 @@
+---
+sidebar_position: 1
+---
+
+## Introduction
+
+Zroker is a gui client for zrok.
+
+## Installation
+
+- Download the latest release from [GitHub](https://github.com/lerte/zroker/releases/latest).
+- Open the app.
+- [Invite](/docs/invite) your email.
diff --git a/docs/docs/img/create-account.png b/docs/docs/img/create-account.png
diff --git a/docs/docs/img/enable-environment.png b/docs/docs/img/enable-environment.png
diff --git a/docs/docs/img/enable.png b/docs/docs/img/enable.png
diff --git a/docs/docs/img/invite.png b/docs/docs/img/invite.png
diff --git a/docs/docs/img/overview.png b/docs/docs/img/overview.png
diff --git a/docs/docs/img/sharing-detail.png b/docs/docs/img/sharing-detail.png
diff --git a/docs/docs/img/sharing-dialog.png b/docs/docs/img/sharing-dialog.png
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
diff --git a/docs/docs/invite.md b/docs/docs/invite.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 2
+---
+
+### Input your email address, then click the **Zroker Invite** button.
+
+![zroker invite](./img/invite.png)
+
+### Check your email, then click **Create Account** button.
+
+![zroker create account](./img/create-account.png)
diff --git a/docs/docs/overview.md b/docs/docs/overview.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 3
+---
+
+![overview list](./img/overview.png)
+![overview sharing detail](./img/sharing-detail.png)
+![overview sharing dialog](./img/sharing-dialog.png)
diff --git a/docs/docs/tutorial-basics/_category_.json b/docs/docs/tutorial-basics/_category_.json
diff --git a/docs/docs/tutorial-basics/congratulations.md b/docs/docs/tutorial-basics/congratulations.md
diff --git a/docs/docs/tutorial-basics/create-a-blog-post.md b/docs/docs/tutorial-basics/create-a-blog-post.md
diff --git a/docs/docs/tutorial-basics/create-a-document.md b/docs/docs/tutorial-basics/create-a-document.md
diff --git a/docs/docs/tutorial-basics/create-a-page.md b/docs/docs/tutorial-basics/create-a-page.md
diff --git a/docs/docs/tutorial-basics/deploy-your-site.md b/docs/docs/tutorial-basics/deploy-your-site.md