8000 [Feature Request]: Add guides, references, best practices, and other documentation that may facilitate user journey with RAGFlow · Issue #720 · infiniflow/ragflow · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
8 of 23 tasks
writinwaters opened this issue May 11, 2024 · 0 comments
Open
8 of 23 tasks

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

writinwaters opened this issue May 11, 2024 · 0 comments
Assignees
@JinHai-CN

Comments

@writinwaters
Copy link
Contributor
writinwaters commented May 11, 2024 •
edited
Loading

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
@JinHai-CN JinHai-CN mentioned this issue May 11, 2024
Closed
27 tasks
This was referenced May 20, 2024
Merged
Merged
@writinwaters writinwaters mentioned this issue Jun 6, 2024
Merged
1 task
KevinHuSh pushed a commit that referenced this issue Jun 7, 2024
@writinwaters
Updated Ollama part of local deployment (#1066)
f65d6a9 
### What problem does this PR solve?

#720 

### Type of change

- [x] Documentation Update
@writinwaters writinwaters mentioned this issue Jun 11, 2024
Merged
1 task
KevinHuSh pushed a commit that referenced this issue Jun 11, 2024
@writinwaters
Updated the doc for configuring api key (#1112)
e28d13e 
### What problem does this PR solve?

#720 

### Type of change

- [x] Documentation Update
@yingfeng yingfeng mentioned this issue Aug 6, 2024
Closed
61 tasks
Halfknow pushed a commit to Halfknow/ragflow that referenced this issue Nov 11, 2024
@writinwaters
Updated Ollama part of local deployment (infiniflow#1066)
14d2493 
### What problem does this PR solve?

infiniflow#720 

### Type of change

- [x] Documentation Update
Halfknow pushed a commit to Halfknow/ragflow that referenced this issue Nov 11, 2024
@writinwaters
Updated the doc for configuring api key (infiniflow#1112)
3fb580c 
### What problem does this PR solve?

infiniflow#720 

### Type of change

- [x] Documentation Update
@yingfeng yingfeng mentioned this issue Dec 24, 2024
Open
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JinHai-CN JinHai-CN

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@JinHai-CN @writinwaters
0