From cea735819a3f643d888a28c2f14b46164c32acb2 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Wed, 1 Oct 2025 19:27:17 -0400 Subject: [PATCH] add-partial-and-admonitions --- docs/docs/_partial-external-preview.mdx | 4 ++++ docs/docs/configure/{configuration.md => configuration.mdx} | 4 +++- docs/docs/core-components/agents.mdx | 4 +++- docs/docs/core-components/ingestion.mdx | 3 +++ docs/docs/core-components/knowledge.mdx | 3 +++ docs/docs/get-started/docker.mdx | 4 ++++ docs/docs/get-started/install.mdx | 3 +++ docs/docs/get-started/quickstart.mdx | 3 +++ docs/docs/get-started/tui.mdx | 4 +++- docs/docs/get-started/what-is-openrag.mdx | 4 ++++ docs/docs/support/troubleshoot.mdx | 3 +++ 11 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 docs/docs/_partial-external-preview.mdx rename docs/docs/configure/{configuration.md => configuration.mdx} (98%) diff --git a/docs/docs/_partial-external-preview.mdx b/docs/docs/_partial-external-preview.mdx new file mode 100644 index 00000000..8563720c --- /dev/null +++ b/docs/docs/_partial-external-preview.mdx @@ -0,0 +1,4 @@ +:::info +OpenRAG is is currently in public preview. +Development is ongoing, and the features and functionality are subject to change. +::: \ No newline at end of file diff --git a/docs/docs/configure/configuration.md b/docs/docs/configure/configuration.mdx similarity index 98% rename from docs/docs/configure/configuration.md rename to docs/docs/configure/configuration.mdx index 2387c2ce..d8058254 100644 --- a/docs/docs/configure/configuration.md +++ b/docs/docs/configure/configuration.mdx @@ -3,7 +3,9 @@ title: Configuration slug: /configure/configuration --- -# Configuration +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + + OpenRAG supports multiple configuration methods with the following priority: diff --git a/docs/docs/core-components/agents.mdx b/docs/docs/core-components/agents.mdx index 1ecdb1cc..abfedc8a 100644 --- a/docs/docs/core-components/agents.mdx +++ b/docs/docs/core-components/agents.mdx @@ -6,8 +6,10 @@ 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'; +import PartialModifyFlows from '@site/docs/_partial-modify-flows.mdx'; +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + OpenRAG leverages Langflow's Agent component to power the OpenRAG OpenSearch Agent flow. diff --git a/docs/docs/core-components/ingestion.mdx b/docs/docs/core-components/ingestion.mdx index 7e5afb20..08071158 100644 --- a/docs/docs/core-components/ingestion.mdx +++ b/docs/docs/core-components/ingestion.mdx @@ -7,6 +7,9 @@ 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'; +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + + OpenRAG uses [Docling](https://docling-project.github.io/docling/) for its document ingestion pipeline. More specifically, OpenRAG uses [Docling Serve](https://github.com/docling-project/docling-serve), which starts a `docling-serve` process on your local machine and runs Docling ingestion through an API service. diff --git a/docs/docs/core-components/knowledge.mdx b/docs/docs/core-components/knowledge.mdx index 852991a7..6933b02f 100644 --- a/docs/docs/core-components/knowledge.mdx +++ b/docs/docs/core-components/knowledge.mdx @@ -7,6 +7,9 @@ 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'; +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + + OpenRAG uses [OpenSearch](https://docs.opensearch.org/latest/) for its vector-backed knowledge store. OpenSearch provides powerful hybrid search capabilities with enterprise-grade security and multi-tenancy support. diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index 84f0fca6..415b39fe 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -3,6 +3,10 @@ title: Docker deployment slug: /get-started/docker --- +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + + + There are two different Docker Compose files. They deploy the same applications and containers, but to different environments. diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 27cafb44..ce3d1531 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -5,6 +5,9 @@ slug: /install import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + + OpenRAG can be installed in multiple ways: diff --git a/docs/docs/get-started/quickstart.mdx b/docs/docs/get-started/quickstart.mdx index b071529b..5d09f67d 100644 --- a/docs/docs/get-started/quickstart.mdx +++ b/docs/docs/get-started/quickstart.mdx @@ -6,6 +6,9 @@ slug: /quickstart import Icon from "@site/src/components/icon/icon"; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + + Get started with OpenRAG by loading your knowledge, swapping out your language model, and then chatting with the OpenRAG API. diff --git a/docs/docs/get-started/tui.mdx b/docs/docs/get-started/tui.mdx index 5ca4e934..49c676f7 100644 --- a/docs/docs/get-started/tui.mdx +++ b/docs/docs/get-started/tui.mdx @@ -3,7 +3,9 @@ title: Terminal User Interface (TUI) commands slug: /get-started/tui --- -# OpenRAG TUI Guide +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + + 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. diff --git a/docs/docs/get-started/what-is-openrag.mdx b/docs/docs/get-started/what-is-openrag.mdx index d52fe12f..5540d92d 100644 --- a/docs/docs/get-started/what-is-openrag.mdx +++ b/docs/docs/get-started/what-is-openrag.mdx @@ -3,6 +3,10 @@ title: What is OpenRAG? slug: / --- +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + + + OpenRAG is an open-source package for building agentic RAG systems. It supports integration with a wide range of orchestration tools, vector databases, and LLM providers. diff --git a/docs/docs/support/troubleshoot.mdx b/docs/docs/support/troubleshoot.mdx index 57dcb4d3..fca6935e 100644 --- a/docs/docs/support/troubleshoot.mdx +++ b/docs/docs/support/troubleshoot.mdx @@ -5,6 +5,9 @@ slug: /support/troubleshoot import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; + + This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG.