Skip to content

docs: add practical RAG troubleshooting checklist#2487

Open
monkeyjack123 wants to merge 1 commit intoopenai:mainfrom
monkeyjack123:kerry/rag-troubleshooting-checklist
Open

docs: add practical RAG troubleshooting checklist#2487
monkeyjack123 wants to merge 1 commit intoopenai:mainfrom
monkeyjack123:kerry/rag-troubleshooting-checklist

Conversation

@monkeyjack123
Copy link

Closes #2483\n\nAdds a compact, implementation-focused checklist for diagnosing RAG failures in production and links to relevant Cookbook examples.\n\n### What this PR includes\n- New article: articles/rag_troubleshooting_checklist.md\n- README pointer under a new RAG troubleshooting section\n\n### Why\nIssue #2483 asks for practical troubleshooting guidance for real-world RAG workflows. This PR provides a neutral, framework-agnostic checklist without external dependencies.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: cf276bc062

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@@ -0,0 +1,34 @@
# RAG Troubleshooting Checklist

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P0 Badge Register new article in publication registry

This commit adds articles/rag_troubleshooting_checklist.md but does not add a matching registry.yaml record, and this repo’s publication workflow requires new content to be registered for static-site inclusion; without that entry, the checklist will be present in the repo but omitted from cookbook.openai.com. Please add a registry item for this path (including its metadata) in the same change.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Suggestion: add an external troubleshooting reference for real-world RAG and retrieval workflows

1 participant