diff --git a/docs/docs/get-started/intro.mdx b/docs/docs/get-started/intro.mdx deleted file mode 100644 index 22763874..00000000 --- a/docs/docs/get-started/intro.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: What is OpenRAG? -slug: / ---- - -# OpenRAG Introduction - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. - -### What you'll need - -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**. - -The classic template will automatically be added to your project after you run the command: - -```bash -npm init docusaurus@latest my-website classic -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. - -The command also installs all necessary dependencies you need to run Docusaurus. - -## Start your site - -Run the development server: - -```bash -cd my-website -npm run start -``` - -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. - -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. - -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/docs/docs/get-started/what-is-openrag.mdx b/docs/docs/get-started/what-is-openrag.mdx new file mode 100644 index 00000000..7b411617 --- /dev/null +++ b/docs/docs/get-started/what-is-openrag.mdx @@ -0,0 +1,19 @@ +--- +title: What is OpenRAG? +slug: /what-is-openrag +--- + +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. + +OpenRAG connects and amplifies three popular, proven open-source projects into one powerful platform: + +* [Langflow](https://docs.langflow.org) - Langflow is a powerful tool to build and deploy AI agents and MCP servers. It supports all major LLMs, vector databases and a growing library of AI tools. + +* [OpenSearch](https://docs.opensearch.org/latest/) - OpenSearch is a community-driven, Apache 2.0-licensed open source search and analytics suite that makes it easy to ingest, search, visualize, and analyze data. + +* [Docling](https://docling-project.github.io/docling/) - Docling simplifies document processing, parsing diverse formats — including advanced PDF understanding — and providing seamless integrations with the gen AI ecosystem. + +OpenRAG builds on Langflow's familiar interface while adding OpenSearch for vector storage and Docling for simplified document parsing, with opinionated flows that serve as ready-to-use recipes for ingestion, retrieval, and generation from popular sources like OneDrive, Google Drive, and AWS. And don't fear: every part of the stack is swappable. Write your own custom components in Python, try different language models, and customize your flows to build an agentic RAG system that solves problems. + +Ready to get started? Install OpenRAG and then run the Quickstart to create a powerful RAG pipeline. \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index c4175c09..4248c3e2 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -71,7 +71,7 @@ const config = { logo: { alt: 'OpenRAG Logo', src: 'img/logo.svg', - href: '/', + href: 'what-is-openrag', }, items: [ { @@ -89,7 +89,7 @@ const config = { items: [ { label: 'Getting Started', - to: '/', + to: 'what-is-openrag', }, ], }, diff --git a/docs/sidebars.js b/docs/sidebars.js index 51a4ddc3..568989e5 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -22,7 +22,7 @@ const sidebars = { items: [ { type: "doc", - id: "get-started/intro", + id: "get-started/what-is-openrag", label: "Introduction" }, {