Skip to content

Conversation

@vblagoje
Copy link
Member

  • Let's start running at least one snippet agents_api.md and then expand from there with more PRs per section
  • Don't forget to change param docs-website/reference/haystack-api/agents_api.md in the future to add more dirs/files

@vblagoje vblagoje requested review from a team as code owners October 29, 2025 14:15
@vblagoje vblagoje added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Oct 29, 2025
@vblagoje vblagoje requested review from dfokina and removed request for a team October 29, 2025 14:15
@vercel
Copy link

vercel bot commented Oct 29, 2025

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

Project Deployment Preview Comments Updated (UTC)
haystack-docs Ready Ready Preview Comment Nov 4, 2025 9:16am

@vblagoje
Copy link
Member Author

vblagoje commented Oct 29, 2025

@dfokina the agents API page is not getting updated on Vercel deployment, any idea why? Nevermind was looking into 2.19 version 🤦

@dfokina
Copy link
Contributor

dfokina commented Oct 29, 2025

Also, @vblagoje , the docstrings of the agent component themselves need to be updated, then the agents reference markdown will be populated with the correct code snippet :)

@vblagoje
Copy link
Member Author

Also, @vblagoje , the docstrings of the agent component themselves need to be updated, then the agents reference markdown will be populated with the correct code snippet :)

Ok will do so. 🙏 @dfokina

@coveralls
Copy link
Collaborator

coveralls commented Oct 31, 2025

Pull Request Test Coverage Report for Build 18969835544

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 23 unchanged lines in 3 files lost coverage.
  • Overall coverage increased (+0.009%) to 92.244%

Files with Coverage Reduction New Missed Lines %
tracing/datadog.py 1 97.83%
components/agents/agent.py 9 96.48%
components/extractors/llm_metadata_extractor.py 13 83.33%
Totals Coverage Status
Change from base Build 18910806708: 0.009%
Covered Lines: 13498
Relevant Lines: 14633

💛 - Coveralls

@vblagoje
Copy link
Member Author

Hm @dfokina but now that I've changed agent.py pydoc to include these details - it is not showing up in the docs, know why?

@dfokina
Copy link
Contributor

dfokina commented Oct 31, 2025

@vblagoje that's because the change would need to be merged first to trigger the pydoc regeneration

@dfokina
Copy link
Contributor

dfokina commented Oct 31, 2025

@vblagoje you can do a separate PR with that, I can quickly approve & we'll see the change in latest (2.20) docs :)

@vblagoje
Copy link
Member Author

Ah ok, I'll add it b4 EOD. We need better example for the main agent.py pydoc

@vblagoje
Copy link
Member Author

vblagoje commented Nov 4, 2025

@dfokina the agent.py pydocs changes are not shown in https://haystack-docs-bva8zi58y-deepset-ai.vercel.app/reference/next/agents-api
Any idea why?

@vblagoje
Copy link
Member Author

vblagoje commented Nov 4, 2025

Nevermind @dfokina just saw #10009 and integrated it

Copy link
Contributor

@dfokina dfokina left a comment

Choose a reason for hiding this comment

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

🤞

@vblagoje vblagoje merged commit df3b138 into main Nov 6, 2025
13 checks passed
@vblagoje vblagoje deleted the first_snippets_run branch November 6, 2025 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ignore-for-release-notes PRs with this flag won't be included in the release notes. topic:CI type:documentation Improvements on the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants