raselmeya94/RAGpedia

Add “How to Use” Tutorial for Specific RAG Tool

Open

#5 opened on Nov 12, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (1 fork)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

Description

Let’s make RAGpedia a practical guide! We’re looking for a “How to Use” tutorial for any of the tools in RAG-LIST.md. The tutorial should include:

  • Overview: What the tool does and what problem it solves.
  • Step-by-Step Guide: Instructions on setting up and using the tool, preferably with sample inputs and expected outputs.
  • Tips: Any best practices or common pitfalls to avoid.

Add your tutorial as a new .md file in the tutorials/ directory, and link it in the main RAG-LIST.md entry for the tool. We appreciate your help in making RAGpedia accessible for everyone!

Contributor guide

Research direction
Choose a RAG tool from RAG LIST.md, then write a tutorial with overview, step by step guide, and tips. Save as .md file in tutorials/ and link it in the main list.
Tech stack
python
Domain
documentationai
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
MarkdownGitBasic RAG knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90