Skip to content

Conversation

@anakin87
Copy link
Member

@anakin87 anakin87 commented Oct 22, 2025

Related Issues

Proposed Changes:

  • add Docusaurus config files
  • introduce a workflow to update API reference on Haystack when a new version of Experimental is released
  • this is different from the current (erroneous) logic for Readme. For Docusaurus:
    • we only update API reference with the release
    • we update all versioned API references (as we do for integrations)

How did you test it?

Tested on this PR. Here is an example PR created: deepset-ai/haystack#9921

Checklist

@coveralls
Copy link

coveralls commented Oct 22, 2025

Pull Request Test Coverage Report for Build 18743237328

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 71.165%

Totals Coverage Status
Change from base Build 18741290601: 0.0%
Covered Lines: 1118
Relevant Lines: 1571

💛 - Coveralls

@anakin87 anakin87 changed the title Docusaurus api ref sync docs: sync API reference updates with Docusaurus on release Oct 23, 2025
@anakin87 anakin87 marked this pull request as ready for review October 23, 2025 09:03
@anakin87 anakin87 requested a review from a team as a code owner October 23, 2025 09:03
@anakin87 anakin87 requested review from dfokina and sjrl and removed request for a team October 23, 2025 09:03
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.

LGTM

@anakin87 anakin87 merged commit c9ed49c into main Oct 23, 2025
10 checks passed
@anakin87 anakin87 deleted the docusaurus-api-ref-sync branch October 23, 2025 09:14
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.

3 participants