From bf3224e7093621b11a1ba756744ba0249bfd6638 Mon Sep 17 00:00:00 2001
From: April M <36110273+aimurphy@users.noreply.github.com>
Date: Tue, 25 Nov 2025 09:43:51 -0800
Subject: [PATCH] flow customization info
---
docs/docs/_partial-modify-flows.mdx | 5 ---
docs/docs/core-components/agents.mdx | 41 +++++++++++++++++++++----
docs/docs/core-components/ingestion.mdx | 2 +-
docs/docs/core-components/knowledge.mdx | 4 +--
docs/docs/get-started/quickstart.mdx | 3 +-
5 files changed, 39 insertions(+), 16 deletions(-)
delete mode 100644 docs/docs/_partial-modify-flows.mdx
diff --git a/docs/docs/_partial-modify-flows.mdx b/docs/docs/_partial-modify-flows.mdx
deleted file mode 100644
index 02ec1502..00000000
--- a/docs/docs/_partial-modify-flows.mdx
+++ /dev/null
@@ -1,5 +0,0 @@
-import Icon from "@site/src/components/icon/icon";
-
-All flows included with OpenRAG are designed to be modular, performant, and provider-agnostic.
-To modify a flow, click **Settings**, and click **Edit in Langflow**.
-OpenRAG's visual editor is based on the [Langflow visual editor](https://docs.langflow.org/concepts-overview), so you can edit your flows to match your specific use case.
\ No newline at end of file
diff --git a/docs/docs/core-components/agents.mdx b/docs/docs/core-components/agents.mdx
index 9d440ddf..c27de881 100644
--- a/docs/docs/core-components/agents.mdx
+++ b/docs/docs/core-components/agents.mdx
@@ -6,7 +6,6 @@ slug: /agents
import Icon from "@site/src/components/icon/icon";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
-import PartialModifyFlows from '@site/docs/_partial-modify-flows.mdx';
OpenRAG leverages Langflow's Agent component to power the OpenRAG OpenSearch Agent flow.
@@ -31,7 +30,7 @@ In an agentic context, tools are functions that the agent can run to perform tas
-## Use the OpenRAG OpenSearch Agent flow {#flow}
+## Use the OpenRAG Chat (OpenRAG OpenSearch Agent flow) {#flow}
If you've chatted with your knowledge in OpenRAG, you've already experienced the OpenRAG OpenSearch Agent chat flow.
To switch OpenRAG over to the [Langflow visual editor](https://docs.langflow.org/concepts-overview) and view the OpenRAG OpenSearch Agentflow, click **Settings**, and then click **Edit in Langflow**.
@@ -48,12 +47,42 @@ This filter is the [Knowledge filter](/knowledge#create-knowledge-filters), and
* The **Agent** component's Output port is connected to the [**Chat Output** component](https://docs.langflow.org/components-io), which returns the final response to the user or application.
* An [**MCP Tools** component](https://docs.langflow.org/mcp-client) is connected to the Agent's **Tools** port. This component calls the [OpenSearch URL Ingestion flow](/ingestion#url-flow), which Langflow uses as an MCP server to fetch content from URLs and store in OpenSearch.
-
+## Inspect and modify flows {#inspect-and-modify-flows}
-For an example of changing out the agent's language model in OpenRAG, see the [Quickstart](/quickstart#change-components).
+All OpenRAG flows are designed to be modular, performant, and provider-agnostic.
-To restore the flow to its initial state, in OpenRAG, click **Settings**, and then click **Restore Flow**.
-OpenRAG warns you that this discards all custom settings. Click **Restore** to restore the flow.
+OpenRAG provides quick access to common settings and an embedded [Langflow visual editor](https://docs.langflow.org/concepts-overview) where you can fully customize the flows to suit your use case.
+
+To modify a flow, click **Settings**. Then, to launch the embedded Langflow visual editor, click **Edit in Langflow**.
+
+For example, to view and edit the built-in **Chat** flow (the **OpenRAG OpenSearch Agent** flow), do the following:
+
+1. In OpenRAG, click **Chat**.
+
+2. Click **Settings**.
+
+ On the **Settings** page, you can edit commonly used parameters like the **Language model** and **Agent Instructions**.
+
+3. For more detail and customization options, click **Edit in Langflow** to launch the Langflow visual editor in a new browser window.
+
+ If prompted to acknowledge that you are entering Langflow, click **Proceed**.
+
+ If Langflow requests login information, enter the `LANGFLOW_SUPERUSER` and `LANGFLOW_SUPERUSER_PASSWORD` from the `.env` file in your OpenRAG installation directory.
+
+ 
+
+4. Modify the flow as desired, and then press Command+S (Ctrl+S) to save your changes.
+
+ You can close the Langflow browser window, or leave it open if you want to continue experimenting with the flow editor.
+
+ :::tip
+ If you modify the built-in **Chat** flow, make sure you click in the **Conversations** tab to start a new conversation. This ensures that the chat doesn't persist any context from the previous conversation with the original model.
+ :::
+
+### Revert a built-in flow to the default state
+
+After you edit a built-in flow, you can click **Restore flow** on the **Settings** page to revert the flow to its original state when you first installed OpenRAG.
+This is a destructive action that discards all customizations to the flow.
## Additional Langflow functionality
diff --git a/docs/docs/core-components/ingestion.mdx b/docs/docs/core-components/ingestion.mdx
index 67f746b0..f09634b9 100644
--- a/docs/docs/core-components/ingestion.mdx
+++ b/docs/docs/core-components/ingestion.mdx
@@ -15,7 +15,7 @@ Docling ingests documents from your local machine or OAuth connectors, splits th
OpenRAG chose Docling for its support for a wide variety of file formats, high performance, and advanced understanding of tables and images.
-To modify OpenRAG's ingestion settings, including the Docling settings and ingestion flows, click 2" aria-hidden="true"/> **Settings**.
+To modify OpenRAG's ingestion settings, including the Docling settings and ingestion flows, **Settings**.
## Knowledge ingestion settings
diff --git a/docs/docs/core-components/knowledge.mdx b/docs/docs/core-components/knowledge.mdx
index 80a997c2..4c8bc6b0 100644
--- a/docs/docs/core-components/knowledge.mdx
+++ b/docs/docs/core-components/knowledge.mdx
@@ -106,9 +106,7 @@ The **Knowledge** page lists the documents OpenRAG has ingested into the OpenSea
To explore your current knowledge, click **Knowledge**.
Click on a document to display the chunks derived from splitting the default documents into the vector database.
-Documents are processed with the default **Knowledge Ingest** flow, so if you want to split your documents differently, edit the **Knowledge Ingest** flow.
-
-
+Documents are processed with the default **Knowledge Ingest** flow. If you want to split your documents differently, edit the **Knowledge Ingest** flow, as explained in [Inspect and modify flows](/agents#inspect-and-modify-flows).
## Create knowledge filters
diff --git a/docs/docs/get-started/quickstart.mdx b/docs/docs/get-started/quickstart.mdx
index 80eb0902..7dd66c7f 100644
--- a/docs/docs/get-started/quickstart.mdx
+++ b/docs/docs/get-started/quickstart.mdx
@@ -135,7 +135,8 @@ You can click a document to view the chunks of the document as they are stored i
3. For this quickstart, try changing the model.
Click the **Language Model** component, and then change the **Model Name** to a different OpenAI model.
- When editing built-in flows, you can click **Restore flow** to revert the flow to its initial state.
+ After you edit a built-in flow, you can click **Restore flow** on the **Settings** page to revert the flow to its original state when you first installed OpenRAG.
+ This is a destructive action that discards all customizations to the flow.
4. Press Command+S (Ctrl+S) to save your changes.