feat(docs): add docs and restructure

2023-12-28 00:06:32 +08:00
parent afc67bc0b9
commit 498374195d
56 changed files with 3751 additions and 54 deletions
@@ -0,0 +1,49 @@
+export const metadata = {
+  title: 'Quickstart',
+  description:
+    'This guide will get you all set up and ready to use the Protocol API. We’ll cover how to get started an API client and how to make your first API request.',
+}
+
+# Getting stated
+
+Install Comfy Deploy's plugin on your local machine to get started with deploying workflow.
+
+<CodeGroup>
+
+```bash {{ title: 'git' }}
+cd custom_nodes
+git clone https://github.com/BennyKok/comfyui-deploy.git
+```
+
+```js {{ language: 'js', title: 'ComfyUI Manager' }}
+// Install with ComfyUI Manager
+Search `ComfyUI Deploy`
+```
+</CodeGroup>
+
+## ComfyUI Manager
+
+Install from ComfyUI Manager
+<Image src="https://media.discordapp.net/attachments/1187301526646030386/1189400730101104660/CleanShot_2023-12-27_at_10.53.272x.png"/>
+
+## Setup your workflow
+
+Add ComfyDeploy node
+
+<Image className="max-w-xl" src="https://cdn.discordapp.com/attachments/1187301526646030386/1189400819741761546/CleanShot_2023-12-27_at_10.54.052x.png"/>
+
+Set a name for your workflow
+
+<Image className="max-w-xl" src="https://cdn.discordapp.com/attachments/1187301526646030386/1189400882773766184/CleanShot_2023-12-27_at_10.54.212x.png"/>
+
+Set up your API key
+
+<Image className="w-fit max-h-48" src="https://cdn.discordapp.com/attachments/1189594955279245403/1189594974149431326/CleanShot_2023-12-27_at_23.45.13.png"/>
+Open the settings panel and then set your API key here, if you dont have one, create here <a href="/api-keys">Create API Key</a>
+<Image className="max-w-lg" src="https://cdn.discordapp.com/attachments/1187301526646030386/1189401104472080514/CleanShot_2023-12-27_at_10.54.372x.png"/>
+
+
+## What's next?
+
+Now, hit the Deploy button and your workflow will be deployed to ComfyUI's server. Check out <a href="/workflows">your workflows here</a>.
+