[PR #213] [CLOSED] Docs: add RAG evaluation and debugging guide (16-problem checklist) #212

Closed
opened 2026-06-05 15:22:42 -04:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Mintplex-Labs/anythingllm-docs/pull/213
Author: @onestardao
Created: 2/28/2026
Status: Closed

Base: mainHead: main


📝 Commits (2)

  • b182202 docs: add RAG evaluation and debugging guide
  • c509dad Add RAG evaluation and debugging section to meta

📊 Changes

2 files changed (+219 additions, -1 deletions)

View changed files

📝 pages/_meta.json (+10 -1)
pages/rag-evaluation-and-debugging.mdx (+209 -0)

📄 Description

Pull Request Type

  • feat
  • 🐛 fix
  • ♻️ refactor
  • 💄 style

Relevant Issues

connect Mintplex-Labs/anything-llm#4975

What is in this change?

  • Add a new guide page rag-evaluation-and-debugging.mdx that walks users through a practical workflow for evaluating and debugging RAG workspaces in AnythingLLM.
  • The guide structures common failure modes into a 16-problem checklist covering ingestion, embeddings, retrieval, context packing, and agent/tool behavior, so users can map symptoms to likely root causes.
  • Update pages/_meta.json to register the new page under the Guides section so it is discoverable from the docs sidebar.

Additional Information

  • The “failure-mode map” style in this guide follows the pattern already used by several RAG and eval resources (for example RAG engines and evaluator collections that group issues by failure type), but the content here is written in a neutral, AnythingLLM-first way.
  • The idea for adding a RAG debugging checklist to the docs was originally discussed in the main AnythingLLM repo issue thread: https://github.com/Mintplex-Labs/anything-llm/issues/4975#issuecomment-3945217700

Validations

  • Ensured updated documentation pass spell check
  • Updated or added relevant links as needed
  • Reviewed the changes for clarity and accuracy
  • Successfully ran the code locally without encountering errors


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Mintplex-Labs/anythingllm-docs/pull/213 **Author:** [@onestardao](https://github.com/onestardao) **Created:** 2/28/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (2) - [`b182202`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/b1822021edeab6e4a00f71373a53a08552b901c7) docs: add RAG evaluation and debugging guide - [`c509dad`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/c509dad16fbbf8dc7a707be97760ba25f3ec4a87) Add RAG evaluation and debugging section to meta ### 📊 Changes **2 files changed** (+219 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `pages/_meta.json` (+10 -1) ➕ `pages/rag-evaluation-and-debugging.mdx` (+209 -0) </details> ### 📄 Description ### Pull Request Type <!-- For change type, change [ ] to [x]. --> * [x] ✨ feat * [ ] 🐛 fix * [ ] ♻️ refactor * [ ] 💄 style ### Relevant Issues <!-- Use "resolves #xxx" to auto resolve on merge. Otherwise, please use "connect #xxx" --> connect Mintplex-Labs/anything-llm#4975 ### What is in this change? <!-- Describe the changes in this PR that are impactful to the documentation site. --> * Add a new guide page `rag-evaluation-and-debugging.mdx` that walks users through a practical workflow for evaluating and debugging RAG workspaces in AnythingLLM. * The guide structures common failure modes into a 16-problem checklist covering ingestion, embeddings, retrieval, context packing, and agent/tool behavior, so users can map symptoms to likely root causes. * Update `pages/_meta.json` to register the new page under the **Guides** section so it is discoverable from the docs sidebar. ### Additional Information <!-- Add any other context about the Pull Request here that was not captured above. --> * The “failure-mode map” style in this guide follows the pattern already used by several RAG and eval resources (for example RAG engines and evaluator collections that group issues by failure type), but the content here is written in a neutral, AnythingLLM-first way. * The idea for adding a RAG debugging checklist to the docs was originally discussed in the main AnythingLLM repo issue thread: [https://github.com/Mintplex-Labs/anything-llm/issues/4975#issuecomment-3945217700](https://github.com/Mintplex-Labs/anything-llm/issues/4975#issuecomment-3945217700) ### Validations <!-- All of the applicable items should be checked. --> * [x] Ensured updated documentation pass spell check * [x] Updated or added relevant links as needed * [x] Reviewed the changes for clarity and accuracy * [x] Successfully ran the code locally without encountering errors --- --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 15:22:42 -04:00
yindo closed this issue 2026-06-05 15:22:42 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Mintplex-Labs/anythingllm-docs#212