search

vectara / vectara-docs

Documentation for Vectara's GenAI Platform
https://docs.vectara.com
Apache License 2.0
8 stars 13 forks source link

executable code examples in the doc #305

Open forrestbao opened 3 months ago

forrestbao commented 3 months ago

Pages

Many pages

Description

A lot of the code snippets are illustrative examples, not executable. It's better if they are executable so readers can copy-and-paste and tweak for their use. This will lower the threshold and latency of developing with Vectara. People with low-tech background can fire up an app without connecting dots on their.

One such example is here https://docs.vectara.com/docs/learn/grounded-generation/configure-query-summarization The code is not executable. Better to be real CURL command or Python code.

pwoznic commented 2 months ago

I have a proposal for improving these examples that I shared with the team and will go over in more detail offline.