gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'main' into 98-bug-copy-chunk-gives-a-messy-paste

Browse source
This commit is contained in:
boneill-ds 2025-10-02 08:06:10 -06:00 • committed by GitHub
commit 1edfe6dadc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
15 changed files with 136 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.github/workflows/deploy-gh-pages.yml vendored
View file

@ -6,8 +6,7 @@ on:
- main
paths:
- 'docs/**'
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
workflow_dispatch:
jobs:
deploy:

4
docs/docs/_partial-external-preview.mdx Normal file
View file

@ -0,0 +1,4 @@
:::info
OpenRAG is is currently in public preview.
Development is ongoing, and the features and functionality are subject to change.
:::

4
docs/docs/configure/configuration.md → docs/docs/configure/configuration.mdx
View file

@ -3,7 +3,9 @@ title: Configuration
slug: /configure/configuration
---
# Configuration
import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
<PartialExternalPreview />
OpenRAG supports multiple configuration methods with the following priority:

4
docs/docs/core-components/agents.mdx
View file

@ -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';
<PartialExternalPreview />
OpenRAG leverages Langflow's Agent component to power the OpenRAG OpenSearch Agent flow.

3
docs/docs/core-components/ingestion.mdx
View file

@ -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';
<PartialExternalPreview />
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.

3
docs/docs/core-components/knowledge.mdx
View file

@ -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';
<PartialExternalPreview />
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.

4
docs/docs/get-started/docker.mdx
View file

@ -3,6 +3,10 @@ title: Docker deployment
slug: /get-started/docker
---
import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
<PartialExternalPreview />
There are two different Docker Compose files.
They deploy the same applications and containers, but to different environments.

3
docs/docs/get-started/install.mdx
View file

@ -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';
<PartialExternalPreview />
OpenRAG can be installed in multiple ways:

3
docs/docs/get-started/quickstart.mdx
View file

@ -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';
<PartialExternalPreview />
Get started with OpenRAG by loading your knowledge, swapping out your language model, and then chatting with the OpenRAG API.

4
docs/docs/get-started/tui.mdx
View file

@ -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';
<PartialExternalPreview />
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.

4
docs/docs/get-started/what-is-openrag.mdx
View file

@ -3,6 +3,10 @@ title: What is OpenRAG?
slug: /
---
import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
<PartialExternalPreview />
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.

3
docs/docs/support/troubleshoot.mdx
View file

@ -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';
<PartialExternalPreview />
This page provides troubleshooting advice for issues you might encounter when using OpenRAG or contributing to OpenRAG.

35
docs/docusaurus.config.js
View file

@ -20,10 +20,10 @@ const config = {
},
// Set the production url of your site here
url: 'https://langflow-ai.github.io',
url: 'https://docs.openr.ag',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: process.env.BASE_URL ? process.env.BASE_URL : '/openrag/',
baseUrl: process.env.BASE_URL ? process.env.BASE_URL : '/',
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
@ -86,39 +86,28 @@ const config = {
},
items: [
{
href: 'https://github.com/openrag/openrag',
label: 'GitHub',
position: 'right',
position: "right",
href: "https://github.com/langflow-ai/openrag",
className: "header-github-link",
target: "_blank",
rel: null,
'aria-label': 'GitHub repository',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Documentation',
title: null,
items: [
{
label: 'Getting Started',
to: '/',
},
],
},
{
title: 'Community',
items: [
{
label: 'GitHub',
href: 'https://github.com/openrag/openrag',
},
{
label: 'Discord',
href: 'https://discord.gg/openrag',
html: `<div class="footer-links">
<span>© ${new Date().getFullYear()} OpenRAG</span>
</div>`,
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} OpenRAG. Built with Docusaurus.`,
},
prism: {
theme: prismThemes.github,

86
docs/src/css/custom.css
View file

@ -28,3 +28,89 @@
--ifm-color-primary-lightest: #4fddbf;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
}
/* GitHub Icon Button */
.header-github-link:hover {
opacity: 0.6;
}
.header-github-link:before {
content: "";
width: 24px;
height: 24px;
display: flex;
background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='currentColor'%3E%3Cpath d='M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z'/%3E%3C/svg%3E") no-repeat;
}
[data-theme="dark"] .header-github-link:before {
content: "";
width: 24px;
height: 24px;
display: flex;
background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='white'%3E%3Cpath d='M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z'/%3E%3C/svg%3E") no-repeat;
}
/* Slim Footer */
.footer {
padding: 1rem 0 0;
background-color: var(--ifm-background-color);
border-top: 1px solid var(--ifm-color-emphasis-200);
}
[data-theme="light"] .footer {
border-top: 1px solid var(--ifm-color-emphasis-300);
}
.footer-content {
display: flex;
justify-content: space-between;
align-items: center;
padding: 0 var(--ifm-navbar-padding-horizontal);
max-width: var(--ifm-container-width);
margin: 0 auto;
font-size: 12px;
}
.footer__copyright {
color: var(--ifm-toc-link-color);
}
.footer-links {
display: flex;
gap: 0.5rem;
font-size: 13px;
}
.footer-links a {
color: var(--ifm-toc-link-color);
text-decoration: none;
}
.footer-links a:hover {
text-decoration: underline;
}
.footer .container {
padding: 0 1.25rem;
display: flex;
justify-content: left;
align-items: center;
flex-direction: row;
max-width: 100%;
}
.footer__title {
margin-bottom: 0;
}
/* Inline Icons */
.markdown svg,
.markdown img[src*="icon"],
.markdown .icon {
width: 16px !important;
height: 16px !important;
stroke-width: 2.5 !important;
display: inline-block;
vertical-align: middle;
}

1
docs/static/CNAME vendored Normal file
View file

@ -0,0 +1 @@
docs.openr.ag