diff --git a/.env.example b/.env.example index 45b7676b..fe908795 100644 --- a/.env.example +++ b/.env.example @@ -8,6 +8,8 @@ LANGFLOW_SECRET_KEY= # flow ids for chat and ingestion flows LANGFLOW_CHAT_FLOW_ID=1098eea1-6649-4e1d-aed1-b77249fb8dd0 LANGFLOW_INGEST_FLOW_ID=5488df7c-b93f-4f87-a446-b67028bc0813 +# Ingest flow using docling +LANGFLOW_INGEST_FLOW_ID=1402618b-e6d1-4ff2-9a11-d6ce71186915 NUDGES_FLOW_ID=ebc01d31-1976-46ce-a385-b0240327226c # Set a strong admin password for OpenSearch; a bcrypt hash is generated at 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/quickstart.mdx b/docs/docs/get-started/quickstart.mdx new file mode 100644 index 00000000..993d9739 --- /dev/null +++ b/docs/docs/get-started/quickstart.mdx @@ -0,0 +1,390 @@ +--- +title: Quickstart +slug: /quickstart +--- + +import Icon from "@site/src/components/icon/icon"; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +Get started with OpenRAG by loading your knowledge, swapping out your language model, and then chatting with the OpenRAG API. + +## Prerequisites + +- Install and start OpenRAG + +## Find your way around + +1. In OpenRAG, click