Skip to content

[Feature Request]: Add guides, references, best practices, and other documentation that may facilitate user journey with RAGFlow #720

@writinwaters

Description

@writinwaters

Is there an existing issue for the same feature request?

  • I have checked the existing issues.

Describe the feature you'd like

  • RAGFlow overview covering its advantages and what differentiates it from its peer RAG apps.
  • P0: Quickstart guide covering installation, a quick set up of a knowledge base, and starting a conversation. Create quickstart.md #743
  • P1: User guide for establishing a knowledge base.
  • P1: User guide for setting up an AI-based conversation.
  • P1: User guide for integrating with third-party apps using conversation API.
  • P1: User guide for uploading and managing files. Added file management guide #788
  • P2: Configurations for both online LLMs and local LLM deployments (Ollama and Xinference) Updated Ollama part of local deployment #1066 Updated the doc for configuring api key #1112
  • P2: Embedding model configurations.
  • P2: Parsing configurations covering template options and chunking size settings.
  • P2: Conversation configurations (assistant, prompt, and model).
  • P2: General configurations (credential settings, environment variable settings, and system management settings).
  • Best practices: choosing chunking templates.
  • Best practices: choosing embedding models.
  • Best practices: system tuning.
  • FAQ (general + troubleshooting)
  • References: Conversation API Reference
  • References: File API Reference
  • References: Deepdoc API Reference
  • Use cases: Contracts
  • Use cases: financial reports (including tables)
  • Use cases: manuals
  • Use cases: chatbot

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions