docs: add Agent Pack documentation#12056
Closed
julian-risch wants to merge 1 commit into
Closed
Conversation
Document the agent_pack integration (agent-pack-haystack) under Haystack Concepts > Agents: a landing page plus one page per agent (Deep Research Agent, Advanced RAG Agent), each with factory-function quick start on top and a README-style architecture deep dive below. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
sjrl
reviewed
Jul 20, 2026
Comment on lines
+64
to
+66
| ## When to Use Agent Pack vs. Building Your Own Agent | ||
|
|
||
| - **Use an Agent Pack agent** when your use case matches what it does — a cited report from web research, or question answering over a document store with rich metadata — and you want working prompts, tool wiring, and budgets out of the box. |
Contributor
There was a problem hiding this comment.
@julian-risch @anakin87 I think having a section like this makes sense
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issues
Proposed Changes:
Adds documentation for the
agent_packintegration (agent-pack-haystack), which currently isn't covered by the Haystack docs at all.New "Agent Pack" category under Haystack Concepts → Agents (sibling of Multi-Agent Systems):
docs/concepts/agents/agent-pack.mdx— landing page: what the pack is, installation, overview table of the agents, shared usage pattern, and when to use the pack vs. building your own Agent.docs/concepts/agents/agent-pack/deep-research-agent.mdx—create_deep_research_agent: quick start, outputs, configuration (swappable LLMs + budgets), and a "How it works" architecture deep dive (Scope→Research→Write hooks, orchestrator/sub-researcher, context isolation & compression).docs/concepts/agents/agent-pack/advanced-rag-agent.mdx—create_advanced_rag_agent: quick start, outputs & citations, configuration, retrieval-pipeline example, and a deep dive (tool loop,DocumentStoreToolsetreuse, filter grammar, supported document stores).Each agent page is two-level: high-level factory-function usage on top for users who just want to import and run an agent, and lower-level architecture details below for users who want to copy the patterns.
Also adds a "Ready-made agents" bullet to
docs/concepts/agents.mdxand registers the pages insidebars.js. Pages target the next docs version only (noversioned_docsmirror), sinceagent-pack-haystackis not released on PyPI yet.How did you test it?
npm run buildindocs-websitepasses (config throws on broken links/anchors, so all cross-references are validated)./docs/next/agent-pack,/docs/next/deep-research-agent,/docs/next/advanced-rag-agent, appear in the sidebar, and the ASCII architecture diagrams render in monospace.Notes for the reviewer
https://docs.haystack.deepset.ai/reference/integrations-agent-packas a full external URL: the reference page is CI-generated on the firstagent_packrelease tag, so a root-relative link would fail the build today. Each occurrence carries a TODO comment to switch after release.:::notewith the git-install command; it should be removed onceagent-pack-haystackis on PyPI. Draft until the release timing is clear.Checklist
I have added unit tests and updated the docstrings.(docs-only)docs:.I have added a release note file(docs-website change, no release note needed)🤖 Generated with Claude Code