From 762ad224f02445ae501821858060654937de4269 Mon Sep 17 00:00:00 2001
From: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
Date: Tue, 30 Sep 2025 22:34:58 -0400
Subject: [PATCH] tui-and-quickstart-peer-review
---
docs/docs/get-started/install.mdx | 2 +-
docs/docs/get-started/quickstart.mdx | 78 ++++++++++++++--------------
docs/docs/get-started/tui.mdx | 6 +--
docs/sidebars.js | 2 +-
4 files changed, 41 insertions(+), 47 deletions(-)
diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx
index f2315a0c..03706199 100644
--- a/docs/docs/get-started/install.mdx
+++ b/docs/docs/get-started/install.mdx
@@ -17,7 +17,7 @@ If you prefer running Docker commands and manually editing `.env` files, see [De
- [uv](https://docs.astral.sh/uv/getting-started/installation/)
- [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/docs/installation) installed
- [Docker Compose](https://docs.docker.com/compose/install/) installed. If using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands.
-- [OpenAI API key](https://platform.openai.com/api-keys)
+- Create an [OpenAI API key](https://platform.openai.com/api-keys)
- Optional: GPU support requires an NVIDIA GPU with CUDA support and compatible NVIDIA drivers installed on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment.
## Install Python wheel {#install-python-wheel}
diff --git a/docs/docs/get-started/quickstart.mdx b/docs/docs/get-started/quickstart.mdx
index b071529b..c2f4b3a5 100644
--- a/docs/docs/get-started/quickstart.mdx
+++ b/docs/docs/get-started/quickstart.mdx
@@ -12,40 +12,6 @@ Get started with OpenRAG by loading your knowledge, swapping out your language m
## Prerequisites
- [Install and start OpenRAG](/install)
-- Create a [Langflow API key](https://docs.langflow.org/api-keys-and-authentication)
-
- Create a Langflow API key
-
- A Langflow API key is a user-specific token you can use with Langflow.
- It is **only** used for sending requests to the Langflow server.
- It does **not** access to OpenRAG.
-
- To create a Langflow API key, do the following:
-
- 1. In Langflow, click your user icon, and then select **Settings**.
- 2. Click **Langflow API Keys**, and then click **Add New**.
- 3. Name your key, and then click **Create API Key**.
- 4. Copy the API key and store it securely.
- 5. To use your Langflow API key in a request, set a `LANGFLOW_API_KEY` environment variable in your terminal, and then include an `x-api-key` header or query parameter with your request.
- For example:
-
- ```bash
- # Set variable
- export LANGFLOW_API_KEY="sk..."
-
- # Send request
- curl --request POST \
- --url "http://LANGFLOW_SERVER_ADDRESS/api/v1/run/FLOW_ID" \
- --header "Content-Type: application/json" \
- --header "x-api-key: $LANGFLOW_API_KEY" \
- --data '{
- "output_type": "chat",
- "input_type": "chat",
- "input_value": "Hello"
- }'
- ```
-
-
## Find your way around
@@ -96,12 +62,44 @@ You can more quickly access the **Language Model** and **Agent Instructions** fi
## Integrate OpenRAG into your application
To integrate OpenRAG into your application, use the [Langflow API](https://docs.langflow.org/api-reference-api-examples).
-Make requests with Python, TypeScript, or any HTTP client to run one of OpenRAG's default flows and get a response, and then modify the flow further to improve results.
+Make requests with Python, TypeScript, or any HTTP client to run one of OpenRAG's default flows and get a response, and then modify the flow further to improve results. Langflow provides code snippets to help you get started.
-Langflow provides code snippets to help you get started with the Langflow API.
-
-1. To navigate to the OpenRAG OpenSearch Agent flow, click **Settings**, and then click **Edit in Langflow** in the OpenRAG OpenSearch Agent flow.
-2. Click **Share**, and then click **API access**.
+1. Create a [Langflow API key](https://docs.langflow.org/api-keys-and-authentication).
+
+ Create a Langflow API key
+
+ A Langflow API key is a user-specific token you can use with Langflow.
+ It is **only** used for sending requests to the Langflow server.
+ It does **not** access to OpenRAG.
+
+ To create a Langflow API key, do the following:
+
+ 1. In Langflow, click your user icon, and then select **Settings**.
+ 2. Click **Langflow API Keys**, and then click **Add New**.
+ 3. Name your key, and then click **Create API Key**.
+ 4. Copy the API key and store it securely.
+ 5. To use your Langflow API key in a request, set a `LANGFLOW_API_KEY` environment variable in your terminal, and then include an `x-api-key` header or query parameter with your request.
+ For example:
+
+ ```bash
+ # Set variable
+ export LANGFLOW_API_KEY="sk..."
+
+ # Send request
+ curl --request POST \
+ --url "http://LANGFLOW_SERVER_ADDRESS/api/v1/run/FLOW_ID" \
+ --header "Content-Type: application/json" \
+ --header "x-api-key: $LANGFLOW_API_KEY" \
+ --data '{
+ "output_type": "chat",
+ "input_type": "chat",
+ "input_value": "Hello"
+ }'
+ ```
+
+
+2. To navigate to the OpenRAG OpenSearch Agent flow, click **Settings**, and then click **Edit in Langflow** in the OpenRAG OpenSearch Agent flow.
+3. Click **Share**, and then click **API access**.
The default code in the API access pane constructs a request with the Langflow server `url`, `headers`, and a `payload` of request data. The code snippets automatically include the `LANGFLOW_SERVER_ADDRESS` and `FLOW_ID` values for the flow. Replace these values if you're using the code for a different server or flow. The default Langflow server address is http://localhost:7860.
@@ -186,7 +184,7 @@ Langflow provides code snippets to help you get started with the Langflow API.
-3. Copy the snippet, paste it in a script file, and then run the script to send the request. If you are using the curl snippet, you can run the command directly in your terminal.
+4. Copy the snippet, paste it in a script file, and then run the script to send the request. If you are using the curl snippet, you can run the command directly in your terminal.
If the request is successful, the response includes many details about the flow run, including the session ID, inputs, outputs, components, durations, and more.
The following is an example of a response from running the **Simple Agent** template flow:
diff --git a/docs/docs/get-started/tui.mdx b/docs/docs/get-started/tui.mdx
index 5ca4e934..0a27a1e8 100644
--- a/docs/docs/get-started/tui.mdx
+++ b/docs/docs/get-started/tui.mdx
@@ -3,13 +3,10 @@ title: Terminal User Interface (TUI) commands
slug: /get-started/tui
---
-# OpenRAG TUI Guide
-
-The OpenRAG Terminal User Interface (TUI) provides a streamlined way to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system.
+The OpenRAG Terminal User Interface (TUI) allows you to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system.
-The TUI offers an easier way to use OpenRAG without sacrificing control.
Instead of starting OpenRAG using Docker commands and manually editing values in the `.env` file, the TUI walks you through the setup. It prompts for variables where required, creates a `.env` file for you, and then starts OpenRAG.
Once OpenRAG is running, use the TUI to monitor your application, control your containers, and retrieve logs.
@@ -17,7 +14,6 @@ Once OpenRAG is running, use the TUI to monitor your application, control your c
## Start the TUI
To start the TUI, run the following commands from the directory where you installed OpenRAG.
-For more information, see [Install OpenRAG](/install).
```bash
uv sync
diff --git a/docs/sidebars.js b/docs/sidebars.js
index e808dabe..e22efa26 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -43,7 +43,7 @@ const sidebars = {
{
type: "doc",
id: "get-started/tui",
- label: "Terminal Interface (TUI)"
+ label: "Terminal User Interface (TUI)"
},
],
},