weaviate-io icon indicating copy to clipboard operation
weaviate-io copied to clipboard

docs: Fix inconsistent example in RAG demo

Open IchordeDionysos opened this issue 7 months ago • 2 comments

What's being changed:

Improves the documentation of this section for the TypeScript v3 SDK version: https://weaviate.io/developers/weaviate/starter-guides/generative#transform-result-sets

CleanShot 2025-04-11 at 08 02 14@2x

All other library versions use the same prompt, however, the TypeScript v3 version prompts to translate it which is really confusing :D

CleanShot 2025-04-11 at 08 03 45@2x

Type of change:

  • [x] Documentation updates (non-breaking change to fix/update documentation)
  • [ ] Website updates (non-breaking change to update main page, company pages, pricing, etc)
  • [ ] Content updates – blog, podcast (non-breaking change to add/update content)
  • [ ] Bug fix (non-breaking change to fixes an issue with the site)
  • [ ] Feature or enhancements (non-breaking change to add functionality)

How Has This Been Tested?

  • [ ] GitHub action – automated build completed without errors
  • [ ] Local build - the site works as expected when running yarn start

note, you can run yarn verify-links to test site links locally

IchordeDionysos avatar Apr 11 '25 08:04 IchordeDionysos

To avoid any confusion in the future about your contribution to Weaviate, we work with a Contributor License Agreement. If you agree, you can simply add a comment to this PR that you agree with the CLA so that we can merge.

beep boop - the Weaviate bot 👋🤖

PS:
Are you already a member of the Weaviate Slack channel?

weaviate-git-bot avatar Apr 11 '25 10:04 weaviate-git-bot

agree

IchordeDionysos avatar Apr 11 '25 11:04 IchordeDionysos

You are absolutely right, thanks for the contribution 😄

g-despot avatar May 19 '25 08:05 g-despot