docs: Add FAQ section#28
Conversation
📝 WalkthroughWalkthroughA new FAQ section has been added to README.md with 14 Q&A entries covering the Controllable RAG Agent's purpose, technical approach, features, operational mechanics, evaluation methods, provider support, setup instructions, dataset customization, verification behavior, anonymization technique, related resources, licensing, and support channels. ChangesFAQ Documentation Addition
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 259-263: Update the README so the "Getting-started" steps and the
`.env` example are consistent: add the missing ANTHROPIC_API_KEY (or other LLM
provider keys you mention) to the `.env` example that currently shows
OPENAI_API_KEY and GROQ_API_KEY, or conversely only list OPENAI_API_KEY and
GROQ_API_KEY in the setup steps; ensure the unique env var names OPENAI_API_KEY,
GROQ_API_KEY and ANTHROPIC_API_KEY are explicitly listed and documented together
so first-time setup and the `.env` example match.
- Around line 251-255: README inconsistency: unify framework and provider setup
by clarifying whether the project uses LangGraph or LangChain (update the
sentence "The agent is built on LangGraph" or the technologies list to match the
actual implementation), and align the environment setup to advertise supported
providers by adding instructions for Anthropic and local models: document
required env vars (e.g., ANTHROPIC_API_KEY, OLLAMA_HOST/OLLAMA_API_KEY or
equivalent) and how to enable local providers (Ollama) alongside OPENAI_API_KEY
and GROQ_API_KEY; update the sentences listing supported providers ("OpenAI",
"Anthropic", "Local models", "Any LangChain-compatible provider") so they match
the setup section and include short notes on how to configure each provider.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| The agent is built on LangGraph and supports: | ||
| - **OpenAI** — GPT-4, GPT-3.5 | ||
| - **Anthropic** — Claude models | ||
| - **Local models** — Via Ollama or other local LLM providers | ||
| - **Any LangChain-compatible provider** |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify framework/provider claims in README for consistency.
rg -n -C2 'LangGraph|LangChain|Anthropic|OpenAI|GROQ|Ollama|API_KEY' README.mdRepository: NirDiamant/Controllable-RAG-Agent
Length of output: 1662
Align LangGraph/LangChain terminology and provider setup instructions in README.
Line 251 claims the agent is built on LangGraph, but line 147 lists LangChain in technologies. Additionally, lines 252–255 advertise support for Anthropic and local models, yet the setup instructions (lines 116–117) only show OPENAI_API_KEY and GROQ_API_KEY. Line 261 mentions Anthropic key setup without providing guidance. Clarify which framework is used and ensure setup instructions match the advertised provider support.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 251 - 255, README inconsistency: unify framework and
provider setup by clarifying whether the project uses LangGraph or LangChain
(update the sentence "The agent is built on LangGraph" or the technologies list
to match the actual implementation), and align the environment setup to
advertise supported providers by adding instructions for Anthropic and local
models: document required env vars (e.g., ANTHROPIC_API_KEY,
OLLAMA_HOST/OLLAMA_API_KEY or equivalent) and how to enable local providers
(Ollama) alongside OPENAI_API_KEY and GROQ_API_KEY; update the sentences listing
supported providers ("OpenAI", "Anthropic", "Local models", "Any
LangChain-compatible provider") so they match the setup section and include
short notes on how to configure each provider.
| 1. Clone the repository | ||
| 2. Install dependencies: `pip install -r requirements.txt` | ||
| 3. Set up your LLM API keys (OpenAI, Anthropic, etc.) | ||
| 4. Prepare your PDF documents | ||
| 5. Run the agent with your custom questions |
There was a problem hiding this comment.
Getting-started keys don’t match the documented .env example.
Line 261 tells users to set OpenAI/Anthropic keys, but the setup block (Lines 116-118) only shows OPENAI_API_KEY and GROQ_API_KEY. Please make these sections consistent so first-time setup doesn’t fail.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 259 - 263, Update the README so the "Getting-started"
steps and the `.env` example are consistent: add the missing ANTHROPIC_API_KEY
(or other LLM provider keys you mention) to the `.env` example that currently
shows OPENAI_API_KEY and GROQ_API_KEY, or conversely only list OPENAI_API_KEY
and GROQ_API_KEY in the setup steps; ensure the unique env var names
OPENAI_API_KEY, GROQ_API_KEY and ANTHROPIC_API_KEY are explicitly listed and
documented together so first-time setup and the `.env` example match.
1 participant
Adds a comprehensive FAQ section covering:
This FAQ helps users quickly understand the agent's sophisticated reasoning capabilities.
Summary by CodeRabbit