Skip to content

Conversation

@drichar
Copy link
Contributor

@drichar drichar commented Jan 14, 2026

Summary

Reverts documentation links to use the existing deflex-api GitBook URL since the haystack-router-api documentation hasn't been set up yet. Also completes the rebranding cleanup by replacing remaining "Deflex" references with "Haystack Router" throughout the codebase.

Changes

  • Documentation links: Reverted API documentation links from haystack-router-api back to deflex-api with note that Haystack Router docs are coming soon
  • README files: Updated root README, packages/haystack/README, and examples README
  • Code comments: Replaced "Deflex" references in source code and tests with "Haystack Router"
  • CLAUDE.md: Added migration note for context
  • Test files: Renamed mock variables from mockDeflexTxn to mockSwapTxn patterns
  • Bundle size badge: Fixed bundlejs.com link to point to correct package

Test Plan

  • All tests pass
  • Documentation links point to working URLs
  • No remaining "Deflex" branding in user-facing documentation

…anding cleanup

The Haystack Router documentation on Gitbook is not yet available, so external
documentation links have been reverted to point to the existing deflex-api docs
until the new documentation is published.

Documentation link fixes:
- Revert all gitbook links from haystack-router-api to deflex-api
- Add note indicating Haystack Router documentation is coming soon
- Fix bundlejs badge link that still referenced @txnlab/deflex

Rebranding cleanup:
- Update anchor links from #deflexclient* to #routerclient*
- Update source code comments (composer.ts, middleware.ts)
- Rename test variables from *Deflex* to *Swap* naming
- Update MIDDLEWARE.md examples and keywords
- Add migration note to .claude/CLAUDE.md
@drichar drichar merged commit e3cac42 into main Jan 14, 2026
1 check passed
@drichar drichar deleted the fix/rebranding-documentation-cleanup branch January 14, 2026 21:26
github-actions bot added a commit that referenced this pull request Jan 14, 2026
## [2.0.3](v2.0.2...v2.0.3) (2026-01-14)

### Bug Fixes

* **docs:** revert documentation links to deflex-api and complete rebranding cleanup ([#3](#3)) ([e3cac42](e3cac42))
@github-actions
Copy link
Contributor

🎉 This PR is included in version 2.0.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants