mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-04-29 06:47:47 +08:00
Docs: Refactored documentation (#13340)
### What problem does this PR solve? Refactored documentation. ### Type of change - [x] Documentation Update
This commit is contained in:
11
docs/administrator/_category_.json
Normal file
11
docs/administrator/_category_.json
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
"label": "Administrator guides",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Guides for system administrtors"
|
||||
},
|
||||
"customProps": {
|
||||
"sidebarIcon": "LucidComputer"
|
||||
}
|
||||
}
|
||||
@ -1,9 +1,9 @@
|
||||
{
|
||||
"label": "Administration",
|
||||
"position": 6,
|
||||
"label": "Admin service",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "RAGFlow administration"
|
||||
"description": "RAGFlow administration service"
|
||||
},
|
||||
"customProps": {
|
||||
"categoryIcon": "LucideUserCog"
|
||||
@ -32,7 +32,6 @@ The service status page displays of all services within the RAGFlow system.
|
||||
- **Extra Info**: Display additional configuration information of a service in a dialog.
|
||||
- **Service Details**: Display detailed status information of a service in a dialog. According to service's type, a service's status information could be displayed as a plain text, a key-value data list, a data table or a bar chart.
|
||||
|
||||
|
||||
### User management
|
||||
|
||||
The user management page provides comprehensive tools for managing all users in the RAGFlow system.
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_position: 0
|
||||
slug: /configurations
|
||||
sidebar_custom_props: {
|
||||
sidebarIcon: LucideCog
|
||||
@ -111,7 +111,7 @@ If you cannot download the RAGFlow Docker image, try the following mirrors.
|
||||
- For the `nightly` edition:
|
||||
- `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:nightly` or,
|
||||
- `RAGFLOW_IMAGE=infiniflow-registry.cn-shanghai.cr.aliyuncs.com/infiniflow/ragflow:nightly`.
|
||||
:::
|
||||
:::
|
||||
|
||||
### Embedding service
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 20
|
||||
sidebar_position: 15
|
||||
slug: /migrate_to_single_bucket_mode
|
||||
---
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
{
|
||||
"label": "Migration",
|
||||
"position": 5,
|
||||
"label": "Data backup and migration",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "RAGFlow migration guide"
|
||||
"description": "Data backup and migration guide"
|
||||
},
|
||||
"customProps": {
|
||||
"categoryIcon": "LucideArrowRightLeft"
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
sidebar_position: 5
|
||||
slug: /tracing
|
||||
sidebar_custom_props: {
|
||||
categoryIcon: LucideLocateFixed
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 11
|
||||
sidebar_position: 1
|
||||
slug: /upgrade_ragflow
|
||||
sidebar_custom_props: {
|
||||
categoryIcon: LucideArrowBigUpDash
|
||||
@ -1,11 +0,0 @@
|
||||
{
|
||||
"label": "Contribution",
|
||||
"position": 8,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Miscellaneous contribution guides."
|
||||
},
|
||||
"customProps": {
|
||||
"sidebarIcon": "LucideHandshake"
|
||||
}
|
||||
}
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "Developers",
|
||||
"label": "Developer guides",
|
||||
"position": 4,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_position: 4
|
||||
slug: /build_docker_image
|
||||
sidebar_custom_props: {
|
||||
categoryIcon: LucidePackage
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_position: 20
|
||||
slug: /contributing
|
||||
sidebar_custom_props: {
|
||||
categoryIcon: LucideBookA
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 3
|
||||
slug: /launch_ragflow_from_source
|
||||
sidebar_custom_props: {
|
||||
categoryIcon: LucideMonitorPlay
|
||||
@ -90,7 +90,7 @@ docker compose -f docker/docker-compose-base.yml up -d
|
||||
```
|
||||
|
||||
3. **Optional:** If you cannot access HuggingFace, set the HF_ENDPOINT environment variable to use a mirror site:
|
||||
|
||||
|
||||
```bash
|
||||
export HF_ENDPOINT=https://hf-mirror.com
|
||||
```
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"label": "MCP",
|
||||
"position": 40,
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Guides and references on accessing RAGFlow's datasets via MCP."
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 10
|
||||
sidebar_position: 20
|
||||
slug: /faq
|
||||
sidebar_custom_props: {
|
||||
sidebarIcon: LucideCircleQuestionMark
|
||||
@ -445,7 +445,7 @@ See [Acquire a RAGFlow API key](./develop/acquire_ragflow_api_key.md).
|
||||
|
||||
### How to upgrade RAGFlow?
|
||||
|
||||
See [Upgrade RAGFlow](./guides/upgrade_ragflow.mdx) for more information.
|
||||
See [Upgrade RAGFlow](./administrator/upgrade_ragflow.mdx) for more information.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
{
|
||||
"label": "Guides",
|
||||
"label": "User guides",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Guides for RAGFlow users and developers."
|
||||
"description": "Guides for RAGFlow users."
|
||||
},
|
||||
"customProps": {
|
||||
"sidebarIcon": "LucideBookMarked"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"label": "Models",
|
||||
"position": -1,
|
||||
"position": 8,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Guides on model settings."
|
||||
|
||||
@ -11,7 +11,7 @@ An API key is required for RAGFlow to interact with an online AI model. This gui
|
||||
|
||||
## Get model API key
|
||||
|
||||
RAGFlow supports most mainstream LLMs. Please refer to [Supported Models](../../references/supported_models.mdx) for a complete list of supported models. You will need to apply for your model API key online. Note that most LLM providers grant newly-created accounts trial credit, which will expire in a couple of months, or a promotional amount of free quota.
|
||||
RAGFlow supports most mainstream LLMs. Please refer to [Supported Models](../../guides/models/supported_models.mdx) for a complete list of supported models. You will need to apply for your model API key online. Note that most LLM providers grant newly-created accounts trial credit, which will expire in a couple of months, or a promotional amount of free quota.
|
||||
|
||||
:::note
|
||||
If you find your online LLM is not on the list, don't feel disheartened. The list is expanding, and you can [file a feature request](https://github.com/infiniflow/ragflow/issues/new?assignees=&labels=feature+request&projects=&template=feature_request.yml&title=%5BFeature+Request%5D%3A+) with us! Alternatively, if you have customized or locally-deployed models, you can [bind them to RAGFlow using Ollama, Xinference, or LocalAI](./deploy_local_llm.mdx).
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
sidebar_position: 0
|
||||
sidebar_position: 2
|
||||
slug: /
|
||||
sidebar_custom_props: {
|
||||
sidebarIcon: LucideRocket
|
||||
}
|
||||
---
|
||||
# Get started
|
||||
# Quickstart
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import APITable from '@site/src/components/APITable';
|
||||
@ -249,7 +249,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
|
||||
|
||||
## Configure LLMs
|
||||
|
||||
RAGFlow is a RAG engine and needs to work with an LLM to offer grounded, hallucination-free question-answering capabilities. RAGFlow supports most mainstream LLMs. For a complete list of supported models, please refer to [Supported Models](./references/supported_models.mdx).
|
||||
RAGFlow is a RAG engine and needs to work with an LLM to offer grounded, hallucination-free question-answering capabilities. RAGFlow supports most mainstream LLMs. For a complete list of supported models, please refer to [Supported Models](./guides/models/supported_models.mdx).
|
||||
|
||||
:::note
|
||||
RAGFlow also supports deploying LLMs locally using Ollama, Xinference, or LocalAI, but this part is not covered in this quick start guide.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 1
|
||||
slug: /release_notes
|
||||
sidebar_custom_props: {
|
||||
sidebarIcon: LucideClipboardPenLine
|
||||
@ -734,7 +734,7 @@ From this release onwards, **service_config.yaml.template** replaces **service_c
|
||||
This approach eliminates the need to manually update **service_config.yaml** after making changes to **.env**, facilitating dynamic environment configurations.
|
||||
|
||||
:::danger IMPORTANT
|
||||
Ensure that you [upgrade **both** your code **and** Docker image to this release](https://ragflow.io/docs/dev/upgrade_ragflow#upgrade-ragflow-to-the-most-recent-officially-published-release) before trying this new approach.
|
||||
Ensure that you [upgrade **both** your code **and** Docker image to this release](./administrator/upgrade_ragflow.mdx#upgrade-ragflow-to-the-most-recent-officially-published-release) before trying this new approach.
|
||||
:::
|
||||
|
||||
### API changes
|
||||
@ -812,13 +812,13 @@ The default Docker image edition is `nightly-slim`. The following list clarifies
|
||||
- `nightly`: The full edition of the most recent tested Docker image.
|
||||
- `v0.12.0`: The full edition of the most recent **officially released** Docker image.
|
||||
|
||||
See [Upgrade RAGFlow](https://ragflow.io/docs/dev/upgrade_ragflow) for instructions on upgrading.
|
||||
See [Upgrade RAGFlow](./administrator/upgrade_ragflow.mdx) for instructions on upgrading.
|
||||
|
||||
### Documentation
|
||||
|
||||
#### Added documents
|
||||
|
||||
- [Upgrade RAGFlow](https://ragflow.io/docs/dev/upgrade_ragflow)
|
||||
- [Upgrade RAGFlow](./administrator/upgrade_ragflow.mdx)
|
||||
|
||||
## v0.11.0
|
||||
|
||||
|
||||
Reference in New Issue
Block a user