docs: update docs icons (#12465)

### What problem does this PR solve?

Update icons for docs.
Trailing spaces are auto truncated by the editor, does not affect real
content.

### Type of change

- [x] Documentation Update
This commit is contained in:
Jimmy Ben Klieve
2026-01-07 10:00:09 +08:00
committed by GitHub
parent ca9645f39b
commit 6814ace1aa
88 changed files with 922 additions and 661 deletions

View File

@ -3,7 +3,7 @@ sidebar_position: 1
slug: /what-is-rag
---
# What is Retreival-Augmented-Generation (RAG)
# What is Retreival-Augmented-Generation (RAG)?
Since large language models (LLMs) became the focus of technology, their ability to handle general knowledge has been astonishing. However, when questions shift to internal corporate documents, proprietary knowledge bases, or real-time data, the limitations of LLMs become glaringly apparent: they cannot access private information outside their training data. Retrieval-Augmented Generation (RAG) was born precisely to address this core need. Before an LLM generates an answer, it first retrieves the most relevant context from an external knowledge base and inputs it as "reference material" to the LLM, thereby guiding it to produce accurate answers. In short, RAG elevates LLMs from "relying on memory" to "having evidence to rely on," significantly improving their accuracy and trustworthiness in specialized fields and real-time information queries.

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /configurations
sidebar_custom_props: {
sidebarIcon: LucideCog
}
---
# Configuration

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Miscellaneous contribution guides."
},
"customProps": {
"sidebarIcon": "LucideHandshake"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /contributing
sidebar_custom_props: {
categoryIcon: LucideBookA
}
---
# Contribution guidelines

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Guides for hardcore developers"
},
"customProps": {
"sidebarIcon": "LucideWrench"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 4
slug: /acquire_ragflow_api_key
sidebar_custom_props: {
categoryIcon: LucideKey
}
---
# Acquire RAGFlow API key

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /build_docker_image
sidebar_custom_props: {
categoryIcon: LucidePackage
}
---
# Build RAGFlow Docker image

View File

@ -1,6 +1,9 @@
---
sidebar_position: 2
slug: /launch_ragflow_from_source
sidebar_custom_props: {
categoryIcon: LucideMonitorPlay
}
---
# Launch service from source

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Guides and references on accessing RAGFlow's datasets via MCP."
},
"customProps": {
"categoryIcon": "SiModelcontextprotocol"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /launch_mcp_server
sidebar_custom_props: {
categoryIcon: LucideTvMinimalPlay
}
---
# Launch RAGFlow MCP server

View File

@ -1,6 +1,9 @@
---
sidebar_position: 3
slug: /mcp_client
sidebar_custom_props: {
categoryIcon: LucideBookMarked
}
---

View File

@ -1,6 +1,9 @@
---
sidebar_position: 2
slug: /mcp_tools
sidebar_custom_props: {
categoryIcon: LucideToolCase
}
---
# RAGFlow MCP tools

View File

@ -1,6 +1,9 @@
---
sidebar_position: 3
slug: /switch_doc_engine
sidebar_custom_props: {
categoryIcon: LucideShuffle
}
---
# Switch document engine

View File

@ -1,6 +1,9 @@
---
sidebar_position: 10
slug: /faq
sidebar_custom_props: {
sidebarIcon: LucideCircleQuestionMark
}
---
# FAQs

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Guides for RAGFlow users and developers."
},
"customProps": {
"sidebarIcon": "LucideBookMarked"
}
}

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "RAGFlow administration"
},
"customProps": {
"categoryIcon": "LucideUserCog"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 2
slug: /admin_cli
sidebar_custom_props: {
categoryIcon: LucideSquareTerminal
}
---
# Admin CLI

View File

@ -1,6 +1,9 @@
---
sidebar_position: 0
slug: /admin_service
sidebar_custom_props: {
categoryIcon: LucideActivity
}
---

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /admin_ui
sidebar_custom_props: {
categoryIcon: LucidePalette
}
---
# Admin UI

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "RAGFlow v0.8.0 introduces an agent mechanism, featuring a no-code workflow editor on the front end and a comprehensive graph-based task orchestration framework on the backend."
},
"customProps": {
"categoryIcon": "RagAiAgent"
}
}

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "A complete reference for RAGFlow's agent components."
},
"customProps": {
"categoryIcon": "RagAiAgent"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 2
slug: /agent_component
sidebar_custom_props: {
categoryIcon: RagAiAgent
}
---
# Agent component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 5
slug: /await_response
sidebar_custom_props: {
categoryIcon: LucideMessageSquareDot
}
---
# Await response component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /begin_component
sidebar_custom_props: {
categoryIcon: LucideHome
}
---
# Begin component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 8
slug: /categorize_component
sidebar_custom_props: {
categoryIcon: LucideSwatchBook
}
---
# Categorize component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 31
slug: /chunker_title_component
sidebar_custom_props: {
categoryIcon: LucideBlocks
}
---
# Title chunker component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 32
slug: /chunker_token_component
sidebar_custom_props: {
categoryIcon: LucideBlocks
}
---
# Token chunker component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 13
slug: /code_component
sidebar_custom_props: {
categoryIcon: LucideCodeXml
}
---
# Code component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 25
slug: /execute_sql
sidebar_custom_props: {
categoryIcon: RagSql
}
---
# Execute SQL tool

View File

@ -1,6 +1,9 @@
---
sidebar_position: 30
slug: /http_request_component
sidebar_custom_props: {
categoryIcon: RagHTTP
}
---
# HTTP request component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 40
slug: /indexer_component
sidebar_custom_props: {
categoryIcon: LucideListPlus
}
---
# Indexer component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 7
slug: /iteration_component
sidebar_custom_props: {
categoryIcon: LucideRepeat2
}
---
# Iteration component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 4
slug: /message_component
sidebar_custom_props: {
categoryIcon: LucideMessageSquareReply
}
---
# Message component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 30
slug: /parser_component
sidebar_custom_props: {
categoryIcon: LucideFilePlay
}
---
# Parser component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 3
slug: /retrieval_component
sidebar_custom_props: {
categoryIcon: LucideFolderSearch
}
---
# Retrieval component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 6
slug: /switch_component
sidebar_custom_props: {
categoryIcon: LucideSplit
}
---
# Switch component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 15
slug: /text_processing
sidebar_custom_props: {
categoryIcon: LucideType
}
---
# Text processing component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 37
slug: /transformer_component
sidebar_custom_props: {
categoryIcon: LucideFileStack
}
---
# Transformer component

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /agent_introduction
sidebar_custom_props: {
categoryIcon: LucideBookOpenText
}
---
# Introduction to agents

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Best practices on Agent configuration."
},
"customProps": {
"categoryIcon": "LucideStar"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 3
slug: /embed_agent_into_webpage
sidebar_custom_props: {
categoryIcon: LucideMonitorDot
}
---
# Embed agent into webpage

View File

@ -1,6 +1,9 @@
---
sidebar_position: 20
slug: /sandbox_quickstart
sidebar_custom_props: {
categoryIcon: LucideCodesandbox
}
---
# Sandbox quickstart

View File

@ -1,6 +1,9 @@
---
sidebar_position: 2
slug: /ai_search
sidebar_custom_props: {
categoryIcon: LucideSearch
}
---
# Search

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Chat-specific guides."
},
"customProps": {
"categoryIcon": "LucideMessagesSquare"
}
}

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Best practices on chat assistant configuration."
},
"customProps": {
"categoryIcon": "LucideStar"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 3
slug: /implement_deep_research
sidebar_custom_props: {
categoryIcon: LucideScanSearch
}
---
# Implement deep research

View File

@ -1,6 +1,9 @@
---
sidebar_position: 4
slug: /set_chat_variables
sidebar_custom_props: {
categoryIcon: LucideVariable
}
---
# Set variables

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /start_chat
sidebar_custom_props: {
categoryIcon: LucideBot
}
---
# Start AI chat

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Guides on configuring a dataset."
},
"customProps": {
"categoryIcon": "LucideDatabaseZap"
}
}

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Add various data sources"
},
"customProps": {
"categoryIcon": "LucideServer"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 3
slug: /add_google_drive
sidebar_custom_props: {
categoryIcon: SiGoogledrive
}
---
# Add Google Drive

View File

@ -1,6 +1,9 @@
---
sidebar_position: -6
slug: /auto_metadata
sidebar_custom_props: {
categoryIcon: LucideFileCodeCorner
}
---
# Auto-extract metadata

View File

@ -1,6 +1,9 @@
---
sidebar_position: 3
slug: /autokeyword_autoquestion
sidebar_custom_props: {
categoryIcon: LucideSlidersHorizontal
}
---
# Auto-keyword Auto-question

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Best practices on configuring a dataset."
},
"customProps": {
"categoryIcon": "LucideStar"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: -4
slug: /configure_child_chunking_strategy
sidebar_custom_props: {
categoryIcon: LucideGroup
}
---
# Configure child chunking strategy

View File

@ -1,6 +1,9 @@
---
sidebar_position: -10
slug: /configure_knowledge_base
sidebar_custom_props: {
categoryIcon: LucideCog
}
---
# Configure dataset

View File

@ -1,6 +1,9 @@
---
sidebar_position: 8
slug: /construct_knowledge_graph
sidebar_custom_props: {
categoryIcon: LucideWandSparkles
}
---
# Construct knowledge graph

View File

@ -1,6 +1,9 @@
---
sidebar_position: 4
slug: /enable_excel2html
sidebar_custom_props: {
categoryIcon: LucideToggleRight
}
---
# Enable Excel2HTML

View File

@ -1,6 +1,9 @@
---
sidebar_position: 7
slug: /enable_raptor
sidebar_custom_props: {
categoryIcon: LucideNetwork
}
---
# Enable RAPTOR

View File

@ -1,6 +1,9 @@
---
sidebar_position: 4
slug: /enable_table_of_contents
sidebar_custom_props: {
categoryIcon: LucideTableOfContents
}
---
# Extract table of contents

View File

@ -1,6 +1,9 @@
---
sidebar_position: -5
slug: /manage_metadata
sidebar_custom_props: {
categoryIcon: LucideCode
}
---
# Manage metadata

View File

@ -1,6 +1,9 @@
---
sidebar_position: 10
slug: /run_retrieval_test
sidebar_custom_props: {
categoryIcon: LucideTextSearch
}
---
# Run retrieval test

View File

@ -1,6 +1,9 @@
---
sidebar_position: -3
slug: /select_pdf_parser
sidebar_custom_props: {
categoryIcon: LucideFileText
}
---
# Select PDF parser

View File

@ -1,6 +1,9 @@
---
sidebar_position: -8
slug: /set_context_window
sidebar_custom_props: {
categoryIcon: LucideListChevronsUpDown
}
---
# Set context window size

View File

@ -1,6 +1,9 @@
---
sidebar_position: -7
slug: /set_metadata
sidebar_custom_props: {
categoryIcon: LucideCode
}
---
# Set metadata

View File

@ -1,6 +1,9 @@
---
sidebar_position: -2
slug: /set_page_rank
sidebar_custom_props: {
categoryIcon: LucideStickyNote
}
---
# Set page rank

View File

@ -1,6 +1,9 @@
---
sidebar_position: 6
slug: /use_tag_sets
sidebar_custom_props: {
categoryIcon: LucideTags
}
---
# Use tag set

View File

@ -1,6 +1,9 @@
---
sidebar_position: 6
slug: /manage_files
sidebar_custom_props: {
categoryIcon: LucideFolderDot
}
---
# Files

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "RAGFlow migration guide"
},
"customProps": {
"categoryIcon": "LucideArrowRightLeft"
}
}

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Guides on model settings."
},
"customProps": {
"categoryIcon": "LucideBox"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 2
slug: /deploy_local_llm
sidebar_custom_props: {
categoryIcon: LucideMonitorCog
}
---
# Deploy local models

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /llm_api_key_setup
sidebar_custom_props: {
categoryIcon: LucideKey
}
---
# Configure model API key

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Team-specific guides."
},
"customProps": {
"categoryIcon": "LucideUsers"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 3
slug: /join_or_leave_team
sidebar_custom_props: {
categoryIcon: LucideLogOut
}
---
# Join or leave a team

View File

@ -1,6 +1,9 @@
---
sidebar_position: 2
slug: /manage_team_members
sidebar_custom_props: {
categoryIcon: LucideUserCog
}
---
# Manage team members

View File

@ -1,6 +1,9 @@
---
sidebar_position: 6
slug: /share_agent
sidebar_custom_props: {
categoryIcon: LucideShare2
}
---
# Share Agent

View File

@ -1,6 +1,9 @@
---
sidebar_position: 5
slug: /share_chat_assistant
sidebar_custom_props: {
categoryIcon: LucideShare2
}
---
# Share chat assistant

View File

@ -1,6 +1,9 @@
---
sidebar_position: 4
slug: /share_datasets
sidebar_custom_props: {
categoryIcon: LucideShare2
}
---
# Share dataset

View File

@ -1,6 +1,9 @@
---
sidebar_position: 7
slug: /share_model
sidebar_custom_props: {
categoryIcon: LucideShare2
}
---
# Share models

View File

@ -1,6 +1,9 @@
---
sidebar_position: 9
slug: /tracing
sidebar_custom_props: {
categoryIcon: LucideLocateFixed
}
---
# Tracing

View File

@ -1,6 +1,9 @@
---
sidebar_position: 11
slug: /upgrade_ragflow
sidebar_custom_props: {
categoryIcon: LucideArrowBigUpDash
}
---
# Upgrading

View File

@ -1,6 +1,9 @@
---
sidebar_position: 0
slug: /
sidebar_custom_props: {
sidebarIcon: LucideRocket
}
---
# Get started

View File

@ -4,5 +4,8 @@
"link": {
"type": "generated-index",
"description": "Miscellaneous References"
},
"customProps": {
"sidebarIcon": "LucideScrollText"
}
}

View File

@ -1,6 +1,9 @@
---
sidebar_position: 0
slug: /glossary
sidebar_custom_props: {
categoryIcon: LucideCaseUpper
}
---
# Glossary

View File

@ -1,6 +1,9 @@
---
sidebar_position: 4
slug: /http_api_reference
sidebar_custom_props: {
categoryIcon: LucideGlobe
}
---
# HTTP API

View File

@ -1,6 +1,9 @@
---
sidebar_position: 5
slug: /python_api_reference
sidebar_custom_props: {
categoryIcon: SiPython
}
---
# Python API

View File

@ -1,6 +1,9 @@
---
sidebar_position: 1
slug: /supported_models
sidebar_custom_props: {
categoryIcon: LucideBox
}
---
# Supported models

View File

@ -1,6 +1,9 @@
---
sidebar_position: 2
slug: /release_notes
sidebar_custom_props: {
sidebarIcon: LucideClipboardPenLine
}
---
# Releases