Skip to content

Commit 1c32156

Browse files
authored
docs: fix broken links and add workflow type callout box (#29)
Fixes some broken links and adds a callout box that states that Comfystream only supports the API workflow format right now.
1 parent b315ce5 commit 1c32156

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

technical/get-started/introduction.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To get started, follow the installation guide below or explore the stream pack f
3131
<Card
3232
title="Install ComfyStream"
3333
icon="download"
34-
href="install"
34+
href="/technical/get-started/install"
3535
>
3636
Step-by-step instructions to install ComfyStream and start creating
3737
real-time workflows.

technical/get-started/quickstart.mdx

+9-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Run your first real-time AI workflow with ComfyStream and see it l
44
icon: "play"
55
---
66

7-
After you have successfully installed ComfyStream by following the [installation guide](install), you can run your first AI workflow.
7+
After you have successfully installed ComfyStream by following the [installation guide](/technical/get-started/install), you can run your first AI workflow.
88

99
## Prerequisites
1010

@@ -21,7 +21,7 @@ Download [example workflows](https://github.com/livepeer/comfystream/tree/main/w
2121
</Accordion>
2222

2323
<Accordion title="Standalone Browser Tab">
24-
If you prefer to run workflows in a new tab rather than inside ComfyUI, click **Open ComfyStream UI** from the [ComfyStream Menu](install#accessing-comfystream).
24+
If you prefer to run workflows in a new tab rather than inside ComfyUI, click **Open ComfyStream UI** from the [ComfyStream Menu](/technical/get-started/install#accessing-comfystream).
2525
This will open a similar dialog box in a new browser tab.
2626
</Accordion>
2727
</AccordionGroup>
@@ -34,6 +34,13 @@ Download [example workflows](https://github.com/livepeer/comfystream/tree/main/w
3434

3535
## Running Your First Workflow
3636

37+
<Info>
38+
ComfyStream currently supports only the API workflow format. To export a
39+
workflow in this format, use **Workflow > Export (API)** in ComfyUI. Support
40+
for the native ComfyUI format is under development and will be available in a
41+
future release.
42+
</Info>
43+
3744
<Steps>
3845
<Step title="Select your workflow">
3946
In the ComfyStream UI, click **Choose files** and select one of the

0 commit comments

Comments
 (0)