Skip to content

docs: remove versioned 2.18 docs and api reference#10761

Draft
julian-risch wants to merge 1 commit intomainfrom
remove-docs-2.18
Draft

docs: remove versioned 2.18 docs and api reference#10761
julian-risch wants to merge 1 commit intomainfrom
remove-docs-2.18

Conversation

@julian-risch
Copy link
Member

@julian-risch julian-risch commented Mar 7, 2026

Related Issues

Haystack was released in September and is about 6 months old. I suggest we remove 2.18 from versioned docs and api reference. One reason is that adding more and more versions slows down building times for the docs website, which Stefano mentioned.

Proposed Changes:

  • Remove 2.18 sidebar
  • Remove 2.18 docs pages
  • Remove 2.18 api reference pages
  • Remove 2.18 from list of versions in docs-website/reference_versions.json
  • Remove 2.18 from list of versions in docs-website/versions.json

How did you test it?

vercel deployment looks good to me

Notes for the reviewer

We could look into automating the removal in future. For example with a workflow that can be manually triggered. A time window of six months for keeping older versions of docs could become standard procedure.
If we see a reason to keep around the 2.18 docs somewhere, we could zip it, upload it and link to it here: https://docs.haystack.deepset.ai/docs/faq#where-is-the-documentation-for-haystack-217-and-older

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.
  • 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.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@julian-risch julian-risch added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Mar 7, 2026
@vercel
Copy link

vercel bot commented Mar 7, 2026

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

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Mar 7, 2026 0:13am

Request Review

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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant