Skip to content

docs: remove API leftovers that no longer exist in core#11949

Merged
julian-risch merged 4 commits into
mainfrom
docs/v3-medium-low-doc-fixes
Jul 13, 2026
Merged

docs: remove API leftovers that no longer exist in core#11949
julian-risch merged 4 commits into
mainfrom
docs/v3-medium-low-doc-fixes

Conversation

@julian-risch

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

Copy link
Copy Markdown
Member

Related Issues

Proposed Changes:

Remove references to APIs that no longer exist in core.

  • connectors/jinareaderconnector.mdx: expected-output comment updated from the legacy non-chat Generator shape to the OpenAIChatGenerator shape (replies with a ChatMessage, metadata in _meta, no top-level meta).
  • Core chat generator pages: removed "(non-chat) Generator" boilerplate. openaichatgenerator.mdx streaming comment is now ChatGenerator-only; azureopenaichatgenerator.mdx, openairesponseschatgenerator.mdx, azureopenairesponseschatgenerator.mdx replace the SomeGeneratorOrChatGenerator placeholder / non-chat branch with a chat-only snippet. Integration generator pages (Anthropic, Ollama, etc.) left untouched.
  • Ready-made GitHub tool pages: "A Tool that allows Agents and ToolInvokers to ..." → "A Tool that allows Agents to ...". Files: githubprcreatortool, githubissueviewertool, githubissuecommentertool, githubrepoviewertool, githubfileeditortool.
  • retrievers/elasticsearchhybridretriever.mdx: "before an ExtractiveReader" → "before a TransformersExtractiveReader".

Notes for the reviewer

Checklist

🤖 Generated with Claude Code

… leftovers

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 8:50pm

Request Review

julian-risch and others added 3 commits July 10, 2026 22:42
Reverts the integration-package annotations added to the pipeline-component
overview tables; restores those 8 tables to their previous state.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Removes the trailing-newline-only change so these two overview tables
remain untouched.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@julian-risch julian-risch changed the title docs: medium/low-priority 3.0 doc cleanup (integration notes, removed-API leftovers) docs: low-priority 3.0 doc cleanup (removed-API leftovers) Jul 10, 2026
@julian-risch julian-risch changed the title docs: low-priority 3.0 doc cleanup (removed-API leftovers) docs: remove API leftovers that no longer exist in core Jul 10, 2026
@julian-risch julian-risch marked this pull request as ready for review July 10, 2026 20:51
@julian-risch julian-risch requested a review from a team as a code owner July 10, 2026 20:51
@julian-risch julian-risch requested review from sjrl and removed request for a team July 10, 2026 20:51

@sjrl sjrl 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.

Looks good!

@julian-risch julian-risch merged commit 4d63087 into main Jul 13, 2026
21 checks passed
@julian-risch julian-risch deleted the docs/v3-medium-low-doc-fixes branch July 13, 2026 06:56
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