mirror of
https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git
synced 2025-06-04 11:24:00 +08:00
Docs: Restructured docs (#7614)
### What problem does this PR solve? ### Type of change - [x] Documentation Update
This commit is contained in:
parent
321a280031
commit
a8dbb5d3b0
@ -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:
|
||||
|
||||
|
8
docs/guides/chat/best_practices/_category_.json
Normal file
8
docs/guides/chat/best_practices/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Best practices",
|
||||
"position": 7,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Best practices on chat assistant configuration."
|
||||
}
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 1
|
||||
slug: /accelerate_question_answering
|
||||
---
|
||||
|
8
docs/guides/dataset/best_practices/_category_.json
Normal file
8
docs/guides/dataset/best_practices/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Best practices",
|
||||
"position": 11,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Best practices on configuring a knowledge base."
|
||||
}
|
||||
}
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_position: 1
|
||||
slug: /accelerate_doc_indexing
|
||||
---
|
||||
|
@ -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
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user