Skip to content

docs: remove documentation for APIs removed in 3.0 (ToolInvoker page, Agent breakpoints, auto tracing)#11955

Merged
julian-risch merged 2 commits into
mainfrom
docs/v3-critical-doc-fixes
Jul 10, 2026
Merged

docs: remove documentation for APIs removed in 3.0 (ToolInvoker page, Agent breakpoints, auto tracing)#11955
julian-risch merged 2 commits into
mainfrom
docs/v3-critical-doc-fixes

Conversation

@julian-risch

@julian-risch julian-risch commented Jul 10, 2026

Copy link
Copy Markdown
Member

Related Issues

Proposed Changes:

Removes documentation for APIs that no longer exist in Haystack 3.0:

  • Delete docs-website/docs/pipeline-components/tools/toolinvoker.mdx and the now-empty "Tools" sidebar category
  • Neutralize internal links to the deleted ToolInvoker page so the docs build cannot fail on broken links (link markup removed, text kept; code examples mentioning ToolInvoker on other pages are deliberately left for a separate PR):
    • docs/tools/ready-made-tools.mdx — reworded to point to the Agent component instead of ToolInvoker.
    • docs/tools/tool.mdx, docs/tools/toolset.mdx, docs/pipeline-components/generators/vertexaigeminichatgenerator.mdx, docs/pipeline-components/generators/googleaigeminichatgenerator.mdx, docs/pipeline-components/generators/guides-to-generators/function-calling.mdx — unlinked ToolInvoker references.
  • docs/concepts/pipelines/pipeline-breakpoints.mdx:
    • Removed the "Setting a Breakpoint on an Agent" and "Resuming Agent Execution" sections.
    • Removed the intro claim about setting breakpoints on an Agent's ChatGenerator/Tools and the stale Agent.run() mentions in the snapshot-callback section.
  • docs/development/tracing.mdx — Replaced the stale "Disabling Auto Tracing" section with a short "Enabling and Disabling Tracing" section: tracing is never enabled automatically; enable it explicitly with haystack.tracing.enable_tracing(...) or a tracing connector component (OpenTelemetryConnector, DatadogConnector), and disable it with haystack.tracing.disable_tracing().
  • docs/overview/migrating-from-langgraphlangchain-to-haystack.mdx — one-line fix in the comparison table: replaced the removed AgentBreakpoint/ToolBreakpoint class names with the existing Breakpoint/PipelineSnapshot API.

How did you test it?

Notes for the reviewer

  • Code examples that still instantiate ToolInvoker on other pages (e.g. tool.mdx, toolset.mdx, function-calling.mdx, Gemini generator pages) are intentionally out of scope and will be rewritten in a follow-up PR; this PR only guarantees no broken links to the deleted page.
  • docs/overview/platform-components.mdx is covered in PR chore: update platform components table #11907

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings. (N/A — docs-only change)
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code. (N/A — docs-only change)
  • I have added a release note file, following the contributors guidelines. (N/A — docs-only change, no release note needed)
  • I have run pre-commit hooks and fixed any issue.

🤖 Generated with Claude Code

…acing docs for 3.0

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jul 10, 2026 12:56pm

Request Review

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@julian-risch julian-risch marked this pull request as ready for review July 10, 2026 13:04
@julian-risch julian-risch requested a review from a team as a code owner July 10, 2026 13:04
@julian-risch julian-risch requested review from davidsbatista and removed request for a team July 10, 2026 13:04
@davidsbatista

Copy link
Copy Markdown
Contributor

looks good to me, only questions is, regarding:

Code examples that still instantiate ToolInvoker on other pages (e.g. tool.mdx, toolset.mdx, function-calling.mdx, Gemini generator pages) are intentionally out of scope and will be rewritten in a follow-up PR; this PR only guarantees no broken links to the deleted page.

Should we wait for that PR be merged first?

@davidsbatista davidsbatista left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@julian-risch

Copy link
Copy Markdown
Member Author

looks good to me, only questions is, regarding:

Code examples that still instantiate ToolInvoker on other pages (e.g. tool.mdx, toolset.mdx, function-calling.mdx, Gemini generator pages) are intentionally out of scope and will be rewritten in a follow-up PR; this PR only guarantees no broken links to the deleted page.

Should we wait for that PR be merged first?

Fair point. I have the PRs in this order on purpose. This way, with this PR getting merged first, there are no breaking links and docs build remains working. Keeps the reviews a bit simpler.

@julian-risch julian-risch merged commit dd3ae34 into main Jul 10, 2026
21 checks passed
@julian-risch julian-risch deleted the docs/v3-critical-doc-fixes branch July 10, 2026 13:36
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.

2 participants