Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

executable code examples in the doc #305

Open
forrestbao opened this issue Jul 11, 2024 · 1 comment
Open

executable code examples in the doc #305

forrestbao opened this issue Jul 11, 2024 · 1 comment
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Comments

@forrestbao
Copy link
Contributor

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.

@forrestbao forrestbao added the bug Something isn't working label Jul 11, 2024
@pwoznic pwoznic self-assigned this Aug 20, 2024
@pwoznic
Copy link
Contributor

pwoznic commented Aug 20, 2024

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

@pwoznic pwoznic added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants