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

[documentation] missing documentation for env variables and all host helpers #1364

Open
sinedied opened this issue Mar 24, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@sinedied
Copy link

While provider and models can all be configured with env variables, it's not easy to find what name should be used for the env vars, and some aren't even in the documentation like GENAISCRIPT_IMAGE_MODEL.

It would be useful to have a documentation about the supported env variables.

In the same idea, not all helpers provided in the GenAIScript environment are documented, like the ShellHost that I found only by looking into the source code.

Helpers are an important part of the scripting environment, and it may be useful to regroup all of them in a dedicated section of the documentation (containers, fetch, host, etc) and add docs for ones that are missing.

Copy link

Okay, here’s my feedback on the issue, designed to be a helpful comment for the developer:

“This is a valuable observation. The lack of clear documentation regarding environment variables (specifically, examples and names like GENAISCIRT_IMAGE_MODEL) and the absence of documentation for host helpers (like ShellHost) significantly increases the onboarding friction for new users.

Grouping all helper functions – containers, fetch, host, etc. – into a dedicated section with clear documentation would be extremely beneficial. It’s a key area for improvement that would dramatically enhance usability.”

AI-generated content by issue-reviewer may be incorrect

@pelikhan pelikhan added the documentation Improvements or additions to documentation label Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants