From b67697b6f207b0f87788b2ad0d650fa7a423bed4 Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Mon, 3 Mar 2025 17:13:37 +0800 Subject: [PATCH] Restructured guides (#5555) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- docs/{guides => }/develop/_category_.json | 4 ++-- .../develop/acquire_ragflow_api_key.md | 0 .../develop/build_docker_image.mdx | 0 .../develop/launch_ragflow_from_source.md | 0 docs/{references => }/faq.md | 8 ++++---- docs/guides/chat/_category_.json | 8 ++++++++ .../accelerate_question_answering.mdx | 15 +++------------ docs/guides/{ => chat}/start_chat.md | 0 .../guides/dataset/accelerate_doc_indexing.mdx | 18 ++++++++++++++++++ docs/guides/manage_team_members.md | 2 +- docs/guides/models/deploy_local_llm.mdx | 2 +- docs/guides/upgrade_ragflow.mdx | 2 +- docs/quickstart.mdx | 4 ++-- docs/release_notes.md | 8 ++++---- 14 files changed, 44 insertions(+), 27 deletions(-) rename docs/{guides => }/develop/_category_.json (68%) rename docs/{guides => }/develop/acquire_ragflow_api_key.md (100%) rename docs/{guides => }/develop/build_docker_image.mdx (100%) rename docs/{guides => }/develop/launch_ragflow_from_source.md (100%) rename docs/{references => }/faq.md (98%) create mode 100644 docs/guides/chat/_category_.json rename docs/guides/{ => chat}/accelerate_question_answering.mdx (77%) rename docs/guides/{ => chat}/start_chat.md (100%) create mode 100644 docs/guides/dataset/accelerate_doc_indexing.mdx diff --git a/docs/guides/develop/_category_.json b/docs/develop/_category_.json similarity index 68% rename from docs/guides/develop/_category_.json rename to docs/develop/_category_.json index 116ee50d..b043d942 100644 --- a/docs/guides/develop/_category_.json +++ b/docs/develop/_category_.json @@ -1,6 +1,6 @@ { - "label": "Develop", - "position": 10, + "label": "Developer guides", + "position": 4, "link": { "type": "generated-index", "description": "Guides for Hardcore Developers" diff --git a/docs/guides/develop/acquire_ragflow_api_key.md b/docs/develop/acquire_ragflow_api_key.md similarity index 100% rename from docs/guides/develop/acquire_ragflow_api_key.md rename to docs/develop/acquire_ragflow_api_key.md diff --git a/docs/guides/develop/build_docker_image.mdx b/docs/develop/build_docker_image.mdx similarity index 100% rename from docs/guides/develop/build_docker_image.mdx rename to docs/develop/build_docker_image.mdx diff --git a/docs/guides/develop/launch_ragflow_from_source.md b/docs/develop/launch_ragflow_from_source.md similarity index 100% rename from docs/guides/develop/launch_ragflow_from_source.md rename to docs/develop/launch_ragflow_from_source.md diff --git a/docs/references/faq.md b/docs/faq.md similarity index 98% rename from docs/references/faq.md rename to docs/faq.md index 2544d501..6e5eb09f 100644 --- a/docs/references/faq.md +++ b/docs/faq.md @@ -3,7 +3,7 @@ sidebar_position: 10 slug: /faq --- -# Frequently asked questions +# FAQ Queries regarding general features, troubleshooting, usage, and more. @@ -65,7 +65,7 @@ RAGFlow has a number of built-in models for document structure parsing, which ac ### Which architectures or devices does RAGFlow support? -We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image. +We officially support x86 CPU and nvidia GPU. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. If you are on an ARM platform, follow [this guide](./develop/build_docker_image) to build a RAGFlow Docker image. --- @@ -130,7 +130,7 @@ Yes, we support enhancing user queries based on existing context of an ongoing c #### How to build the RAGFlow image from scratch? -See [Build a RAGFlow Docker image](https://ragflow.io/docs/dev/build_docker_image). +See [Build a RAGFlow Docker image](./develop/build_docker_image). --- @@ -453,7 +453,7 @@ This error occurs because there are too many chunks matching your search criteri ### How to get an API key for integration with third-party applications? -See [Acquire a RAGFlow API key](../guides/develop/acquire_ragflow_api_key.md). +See [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md). --- diff --git a/docs/guides/chat/_category_.json b/docs/guides/chat/_category_.json new file mode 100644 index 00000000..4b33e0c7 --- /dev/null +++ b/docs/guides/chat/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Chat", + "position": 1, + "link": { + "type": "generated-index", + "description": "Chat-specific guides." + } +} diff --git a/docs/guides/accelerate_question_answering.mdx b/docs/guides/chat/accelerate_question_answering.mdx similarity index 77% rename from docs/guides/accelerate_question_answering.mdx rename to docs/guides/chat/accelerate_question_answering.mdx index 5daf604b..738b81d4 100644 --- a/docs/guides/accelerate_question_answering.mdx +++ b/docs/guides/chat/accelerate_question_answering.mdx @@ -1,25 +1,16 @@ --- sidebar_position: 2 -slug: /accelerate_doc_indexing_and_question_answering +slug: /accelerate_question_answering --- -# Accelerate document indexing and question answering +# Accelerate question answering import APITable from '@site/src/components/APITable'; A checklist to speed up document parsing and question answering. --- -Please note that some of your settings may consume a significant amount of time. If you often find that document parsing and question answering are time-consuming, here is a checklist to consider: - -## 1. Accelerate document indexing - -- Use GPU to reduce embedding time. -- On the configuration page of your knowledge base, switch off **Use RAPTOR to enhance retrieval**. -- Extracting knowledge graph (GraphRAG) is time-consuming. -- Disable **Auto-keyword** and **Auto-question** on the configuration page of yor knowledge base, as both depend on the LLM. - -## 2. Accelerate question answering +Please note that some of your settings may consume a significant amount of time. If you often find that your question answering is time-consuming, here is a checklist to consider: - In the **Prompt Engine** tab of your **Chat Configuration** dialogue, disabling **Multi-turn optimization** will reduce the time required to get an answer from the LLM. - In the **Prompt Engine** tab of your **Chat Configuration** dialogue, leaving the **Rerank model** field empty will significantly decrease retrieval time. diff --git a/docs/guides/start_chat.md b/docs/guides/chat/start_chat.md similarity index 100% rename from docs/guides/start_chat.md rename to docs/guides/chat/start_chat.md diff --git a/docs/guides/dataset/accelerate_doc_indexing.mdx b/docs/guides/dataset/accelerate_doc_indexing.mdx new file mode 100644 index 00000000..ed4fb893 --- /dev/null +++ b/docs/guides/dataset/accelerate_doc_indexing.mdx @@ -0,0 +1,18 @@ +--- +sidebar_position: 9 +slug: /accelerate_doc_indexing +--- + +# Accelerate document indexing +import APITable from '@site/src/components/APITable'; + +A checklist to speed up document parsing. + +--- + +Please note that some of your settings may consume a significant amount of time. If you often find that document parsing is time-consuming, here is a checklist to consider: + +- Use GPU to reduce embedding time. +- On the configuration page of your knowledge base, switch off **Use RAPTOR to enhance retrieval**. +- Extracting knowledge graph (GraphRAG) is time-consuming. +- Disable **Auto-keyword** and **Auto-question** on the configuration page of yor knowledge base, as both depend on the LLM. \ No newline at end of file diff --git a/docs/guides/manage_team_members.md b/docs/guides/manage_team_members.md index 4201696e..2f99e1a4 100644 --- a/docs/guides/manage_team_members.md +++ b/docs/guides/manage_team_members.md @@ -3,7 +3,7 @@ sidebar_position: 4 slug: /manage_team_members --- -# Manage team members +# Team Invite or remove team members, join or leave a team. diff --git a/docs/guides/models/deploy_local_llm.mdx b/docs/guides/models/deploy_local_llm.mdx index 75b3e320..d0e980f7 100644 --- a/docs/guides/models/deploy_local_llm.mdx +++ b/docs/guides/models/deploy_local_llm.mdx @@ -25,7 +25,7 @@ This user guide does not intend to cover much of the installation or configurati :::note - For information about downloading Ollama, see [here](https://github.com/ollama/ollama?tab=readme-ov-file#ollama). -- For information about configuring Ollama server, see [here](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server). +- For information about configuring Ollama server, see [here](../../faq.md#how-do-i-configure-ollama-server). - For a complete list of supported models and variants, see the [Ollama model library](https://ollama.com/library). ::: diff --git a/docs/guides/upgrade_ragflow.mdx b/docs/guides/upgrade_ragflow.mdx index fa63788f..2d0ddb94 100644 --- a/docs/guides/upgrade_ragflow.mdx +++ b/docs/guides/upgrade_ragflow.mdx @@ -3,7 +3,7 @@ sidebar_position: 11 slug: /upgrade_ragflow --- -# Upgrade RAGFlow +# Upgrade import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 5693c10d..ff4c7793 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -20,7 +20,7 @@ This quick start guide describes a general process from: :::danger IMPORTANT We officially support x86 CPU and Nvidia GPU, and this document offers instructions on deploying RAGFlow using Docker on x86 platforms. While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. -If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image. +If you are on an ARM platform, follow [this guide](./develop/build_docker_image) to build a RAGFlow Docker image. ::: ## Prerequisites @@ -356,7 +356,7 @@ Conversations in RAGFlow are based on a particular knowledge base or multiple kn :::tip NOTE RAGFlow also offers HTTP and Python APIs for you to integrate RAGFlow's capabilities into your applications. Read the following documents for more information: -- [Acquire a RAGFlow API key](./guides/develop/acquire_ragflow_api_key.md) +- [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md) - [HTTP API reference](./references/http_api_reference.md) - [Python API reference](./references/python_api_reference.md) ::: diff --git a/docs/release_notes.md b/docs/release_notes.md index 94dc2b93..4453aac0 100644 --- a/docs/release_notes.md +++ b/docs/release_notes.md @@ -205,9 +205,9 @@ pip install ragflow-sdk==0.13.0 #### Added documents -- [Acquire a RAGFlow API key](https://ragflow.io/docs/dev/acquire_ragflow_api_key) -- [HTTP API Reference](https://ragflow.io/docs/dev/http_api_reference) -- [Python API Reference](https://ragflow.io/docs/dev/python_api_reference) +- [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md) +- [HTTP API Reference](./references/http_api_reference.md) +- [Python API Reference](./references/python_api_reference.md) ## v0.12.0 @@ -315,7 +315,7 @@ Released on May 31, 2024. :::danger IMPORTANT While we also test RAGFlow on ARM64 platforms, we do not maintain RAGFlow Docker images for ARM. -If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image. +If you are on an ARM platform, follow [this guide](./develop/build_docker_image) to build a RAGFlow Docker image. ::: ### Related APIs