From a8dbb5d3b04d28b43a85801341dd21b64cb715ce Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Tue, 13 May 2025 15:49:08 +0800 Subject: [PATCH] Docs: Restructured docs (#7614) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- docs/develop/mcp/launch_mcp_server.md | 8 ++++---- docs/guides/chat/best_practices/_category_.json | 8 ++++++++ .../accelerate_question_answering.mdx | 2 +- docs/guides/dataset/best_practices/_category_.json | 8 ++++++++ .../{ => best_practices}/accelerate_doc_indexing.mdx | 2 +- docs/guides/dataset/enable_excel2html.md | 6 +++--- 6 files changed, 25 insertions(+), 9 deletions(-) create mode 100644 docs/guides/chat/best_practices/_category_.json rename docs/guides/chat/{ => best_practices}/accelerate_question_answering.mdx (99%) create mode 100644 docs/guides/dataset/best_practices/_category_.json rename docs/guides/dataset/{ => best_practices}/accelerate_doc_indexing.mdx (98%) diff --git a/docs/develop/mcp/launch_mcp_server.md b/docs/develop/mcp/launch_mcp_server.md index 92ab2def3..ea7bc928b 100644 --- a/docs/develop/mcp/launch_mcp_server.md +++ b/docs/develop/mcp/launch_mcp_server.md @@ -26,7 +26,7 @@ Once a connection is established, an MCP server communicates with its client in 2. Have your RAGFlow API key ready. See [Acquire a RAGFlow API key](./acquire_ragflow_api_key.md). :::tip INFO -If you wish to try out our MCP server without upgrading RAGFlow, community contributor **yiminghub2024** 👏 shares their recommended steps [here](#launch-an-mcp-server-without-upgrading-ragflow). +If you wish to try out our MCP server without upgrading RAGFlow, community contributor [yiminghub2024](https://github.com/yiminghub2024) 👏 shares their recommended steps [here](#launch-an-mcp-server-without-upgrading-ragflow). ::: ## Launch an MCP server @@ -94,7 +94,7 @@ Where: - `host`: host mode. - `mcp-host-api_key`: Required in self-host mode to authenticate the MCP server with the RAGFlow server. -#### 2. Launch a RAGFlow server alongside an MCP server +#### 2. Launch a RAGFlow server with an MCP server Run `docker compose -f docker-compose.yml` to launch the RAGFlow server together with the MCP server. @@ -159,9 +159,9 @@ This section is contributed by our community contributor [yiminghub2024](https:/ i. Copy the [mcp/](https://github.com/infiniflow/ragflow/tree/main/mcp) directory to your local working directory. ii. Copy [docker/docker-compose.yml](https://github.com/infiniflow/ragflow/blob/main/docker/docker-compose.yml) locally. iii. Copy [docker/entrypoint.sh](https://github.com/infiniflow/ragflow/blob/main/docker/entrypoint.sh) locally. - iv. Install required dependencies using `uv`: + iv. Install the required dependencies using `uv`: - Run `uv add mcp` or - - Copy pyproject.toml and run `uv sync --python 3.10 --all-extras`. + - Copy [pyproject.toml](https://github.com/infiniflow/ragflow/blob/main/pyproject.toml) locally and run `uv sync --python 3.10 --all-extras`. 2. Edit **docker-compose.yml** to enable MCP (disabled by default). 3. Launch the MCP server: diff --git a/docs/guides/chat/best_practices/_category_.json b/docs/guides/chat/best_practices/_category_.json new file mode 100644 index 000000000..e92bb793d --- /dev/null +++ b/docs/guides/chat/best_practices/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Best practices", + "position": 7, + "link": { + "type": "generated-index", + "description": "Best practices on chat assistant configuration." + } +} diff --git a/docs/guides/chat/accelerate_question_answering.mdx b/docs/guides/chat/best_practices/accelerate_question_answering.mdx similarity index 99% rename from docs/guides/chat/accelerate_question_answering.mdx rename to docs/guides/chat/best_practices/accelerate_question_answering.mdx index 68703ca3c..408a403ab 100644 --- a/docs/guides/chat/accelerate_question_answering.mdx +++ b/docs/guides/chat/best_practices/accelerate_question_answering.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 1 slug: /accelerate_question_answering --- diff --git a/docs/guides/dataset/best_practices/_category_.json b/docs/guides/dataset/best_practices/_category_.json new file mode 100644 index 000000000..52098b7d8 --- /dev/null +++ b/docs/guides/dataset/best_practices/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Best practices", + "position": 11, + "link": { + "type": "generated-index", + "description": "Best practices on configuring a knowledge base." + } +} diff --git a/docs/guides/dataset/accelerate_doc_indexing.mdx b/docs/guides/dataset/best_practices/accelerate_doc_indexing.mdx similarity index 98% rename from docs/guides/dataset/accelerate_doc_indexing.mdx rename to docs/guides/dataset/best_practices/accelerate_doc_indexing.mdx index 84212bb6c..7765d8b4a 100644 --- a/docs/guides/dataset/accelerate_doc_indexing.mdx +++ b/docs/guides/dataset/best_practices/accelerate_doc_indexing.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 9 +sidebar_position: 1 slug: /accelerate_doc_indexing --- diff --git a/docs/guides/dataset/enable_excel2html.md b/docs/guides/dataset/enable_excel2html.md index e670eedac..ae01f1998 100644 --- a/docs/guides/dataset/enable_excel2html.md +++ b/docs/guides/dataset/enable_excel2html.md @@ -5,19 +5,19 @@ slug: /enable_excel2html # Enable Excel2HTML -Convert Excel spreadsheets into HTML tables. +Convert complex Excel spreadsheets into HTML tables. --- When using the General chunking method, you can enable the **Excel to HTML** toggle to convert spreadsheet files into HTML tables. If it is disabled, spreadsheet tables will be represented as key-value pairs. For complex tables that cannot be simply represented this way, you must enable this feature. -:::danger WARNING +:::caution WARNING The feature is disabled by default. If your knowledge base contains spreadsheets with complex tables and you do not enable this feature, RAGFlow will not throw an error but your tables are likely to be garbled. ::: ## Scenarios -Works with complex tables cannot be represented as key-value pairs. Examples include spreadsheet tables with multiple columns, tables with merged cells, or multiple tables within one sheet. In such cases, consider converting these spreadsheet tables into HTML tables. +Works with complex tables that cannot be represented as key-value pairs. Examples include spreadsheet tables with multiple columns, tables with merged cells, or multiple tables within one sheet. In such cases, consider converting these spreadsheet tables into HTML tables. ## Considerations