diff --git a/docs/genaisrc/blog-image.genai.mts b/docs/genaisrc/blog-image.genai.mts index 71f2c6579e..e27fae6dcc 100644 --- a/docs/genaisrc/blog-image.genai.mts +++ b/docs/genaisrc/blog-image.genai.mts @@ -1,5 +1,5 @@ -script({ parameters: { force: false } }) -const file = env.files.find(({ filename }) => /\.mdx?$/.test(filename)) +script({ parameters: { force: false }, accept: ".md,.mdx" }) +const file = env.files[0] const target = path.changeext(file.filename, ".png") const fm = MD.frontmatter(file.content) diff --git a/docs/genaisrc/docs-image.genai.mts b/docs/genaisrc/docs-image.genai.mts new file mode 100644 index 0000000000..03c4f9a409 --- /dev/null +++ b/docs/genaisrc/docs-image.genai.mts @@ -0,0 +1,60 @@ +script({ parameters: { force: false }, accept: ".md,.mdx" }) +const { force } = env.vars +const file = env.files[0] +const target = path.changeext(file.filename, ".png") +if (!force && (await workspace.stat(target))) + cancel("hero image already exists") + +const fm = MD.frontmatter(file.content) +// phase 1: generate image prompt +const style = + "iconic, 2D, 8-bit, corporate, 5-color, simple, geometric, 128x128. no people, no text, flat design, minimalistic, no background, no shadows, no gradients, no reflections, no 3D elements, no depth, no perspective, no realism, no photography, no realism, no photorealism" +const { text: imagePrompt } = await runPrompt( + (_) => { + _.def("CONTENT", MD.content(file.content)) + _.$`Generate an image prompt for DALLE-3 that illustrates the contents of . +Include specific description related to the content of . + ${style}` + }, + { responseType: "text", systemSafety: false } +) + +// phase 2: generate image +const image = await generateImage( + `${imagePrompt} + STYLE: + ${style}`, + { + mime: "image/png", + size: "1024x1024", + scale: 1, + maxHeight: 762, + style: "vivid", + autoCrop: true + } +) + +// phase 3: generate alt text +const { text: alt } = await prompt` +Generate an alt text description from . +Rephrase the prompt in a way that would be useful for someone who cannot see the image. +Do not start with "Alt Text:". + +IMAGE_PROMPT: +${imagePrompt}`.options({ + responseType: "text", + systemSafety: false, + label: "alt-text", +}) + +// phase 4: patch frontmatter +fm.hero = { + image: { + alt, + file: "./" + path.basename(target), + }, +} +await workspace.copyFile(image.image.filename, target) + +file.content = MD.updateFrontmatter(file.content, fm) +await workspace.writeFiles(file) diff --git a/docs/src/content/docs/blog/anthropic.png b/docs/src/content/docs/blog/anthropic.png index 88a0c7cc6e..0b33e843a2 100644 Binary files a/docs/src/content/docs/blog/anthropic.png and b/docs/src/content/docs/blog/anthropic.png differ diff --git a/docs/src/content/docs/blog/ast-grep-and-transform.png b/docs/src/content/docs/blog/ast-grep-and-transform.png index 55ab07587f..ca3517407a 100644 Binary files a/docs/src/content/docs/blog/ast-grep-and-transform.png and b/docs/src/content/docs/blog/ast-grep-and-transform.png differ diff --git a/docs/src/content/docs/blog/automatic-web-page-content-analysis-with-genaiscript-.png b/docs/src/content/docs/blog/automatic-web-page-content-analysis-with-genaiscript-.png index 1f3b4cc0e9..a3c47e4365 100644 Binary files a/docs/src/content/docs/blog/automatic-web-page-content-analysis-with-genaiscript-.png and b/docs/src/content/docs/blog/automatic-web-page-content-analysis-with-genaiscript-.png differ diff --git a/docs/src/content/docs/blog/azure-ai-search.png b/docs/src/content/docs/blog/azure-ai-search.png index db694f7526..3306098bc7 100644 Binary files a/docs/src/content/docs/blog/azure-ai-search.png and b/docs/src/content/docs/blog/azure-ai-search.png differ diff --git a/docs/src/content/docs/blog/blog-images.png b/docs/src/content/docs/blog/blog-images.png index 3c059e9f98..d6ae884448 100644 Binary files a/docs/src/content/docs/blog/blog-images.png and b/docs/src/content/docs/blog/blog-images.png differ diff --git a/docs/src/content/docs/blog/blog-narration.png b/docs/src/content/docs/blog/blog-narration.png index c875dfea8d..860ce44597 100644 Binary files a/docs/src/content/docs/blog/blog-narration.png and b/docs/src/content/docs/blog/blog-narration.png differ diff --git a/docs/src/content/docs/blog/creating-release-notes-with-genai.png b/docs/src/content/docs/blog/creating-release-notes-with-genai.png index 88990ce20a..4bb51d885d 100644 Binary files a/docs/src/content/docs/blog/creating-release-notes-with-genai.png and b/docs/src/content/docs/blog/creating-release-notes-with-genai.png differ diff --git a/docs/src/content/docs/blog/fallback-tools.png b/docs/src/content/docs/blog/fallback-tools.png index 5e59534184..e0de6a945c 100644 Binary files a/docs/src/content/docs/blog/fallback-tools.png and b/docs/src/content/docs/blog/fallback-tools.png differ diff --git a/docs/src/content/docs/blog/gentle-introduction-to-genaiscript.png b/docs/src/content/docs/blog/gentle-introduction-to-genaiscript.png index 4b12ab3fea..2ad8d39027 100644 Binary files a/docs/src/content/docs/blog/gentle-introduction-to-genaiscript.png and b/docs/src/content/docs/blog/gentle-introduction-to-genaiscript.png differ diff --git a/docs/src/content/docs/blog/gists.png b/docs/src/content/docs/blog/gists.png index 8d2838ed2c..a40ec53924 100644 Binary files a/docs/src/content/docs/blog/gists.png and b/docs/src/content/docs/blog/gists.png differ diff --git a/docs/src/content/docs/blog/github-models-in-github-actions.png b/docs/src/content/docs/blog/github-models-in-github-actions.png index 40bea9f3a4..0c5afdde1c 100644 Binary files a/docs/src/content/docs/blog/github-models-in-github-actions.png and b/docs/src/content/docs/blog/github-models-in-github-actions.png differ diff --git a/docs/src/content/docs/blog/hugging-face-transformers.png b/docs/src/content/docs/blog/hugging-face-transformers.png index e17c852019..251e877f67 100644 Binary files a/docs/src/content/docs/blog/hugging-face-transformers.png and b/docs/src/content/docs/blog/hugging-face-transformers.png differ diff --git a/docs/src/content/docs/blog/llm-agents.png b/docs/src/content/docs/blog/llm-agents.png index 990d0bc502..2af81d1779 100644 Binary files a/docs/src/content/docs/blog/llm-agents.png and b/docs/src/content/docs/blog/llm-agents.png differ diff --git a/docs/src/content/docs/blog/makeitbetter.png b/docs/src/content/docs/blog/makeitbetter.png index fd9909def2..e3e1d3d7c9 100644 Binary files a/docs/src/content/docs/blog/makeitbetter.png and b/docs/src/content/docs/blog/makeitbetter.png differ diff --git a/docs/src/content/docs/blog/mcp-agents.png b/docs/src/content/docs/blog/mcp-agents.png index 7fad731966..d069273f52 100644 Binary files a/docs/src/content/docs/blog/mcp-agents.png and b/docs/src/content/docs/blog/mcp-agents.png differ diff --git a/docs/src/content/docs/blog/mcp-intents.png b/docs/src/content/docs/blog/mcp-intents.png index bae4836fdd..82cc85db36 100644 Binary files a/docs/src/content/docs/blog/mcp-intents.png and b/docs/src/content/docs/blog/mcp-intents.png differ diff --git a/docs/src/content/docs/blog/mcp-resources.png b/docs/src/content/docs/blog/mcp-resources.png index c814c4f672..fb7999d257 100644 Binary files a/docs/src/content/docs/blog/mcp-resources.png and b/docs/src/content/docs/blog/mcp-resources.png differ diff --git a/docs/src/content/docs/blog/mcp-tool-validation.png b/docs/src/content/docs/blog/mcp-tool-validation.png index 2d12496f1b..7eeb239623 100644 Binary files a/docs/src/content/docs/blog/mcp-tool-validation.png and b/docs/src/content/docs/blog/mcp-tool-validation.png differ diff --git a/docs/src/content/docs/blog/node-api.png b/docs/src/content/docs/blog/node-api.png index 9750a49351..a51247a0d8 100644 Binary files a/docs/src/content/docs/blog/node-api.png and b/docs/src/content/docs/blog/node-api.png differ diff --git a/docs/src/content/docs/blog/playground.png b/docs/src/content/docs/blog/playground.png index b8fb683989..c51fee8027 100644 Binary files a/docs/src/content/docs/blog/playground.png and b/docs/src/content/docs/blog/playground.png differ diff --git a/docs/src/content/docs/blog/prompting-is-the-new-scripting.png b/docs/src/content/docs/blog/prompting-is-the-new-scripting.png index 880f3b2fcf..35553f68e3 100644 Binary files a/docs/src/content/docs/blog/prompting-is-the-new-scripting.png and b/docs/src/content/docs/blog/prompting-is-the-new-scripting.png differ diff --git a/docs/src/content/docs/blog/readme-maintenance.png b/docs/src/content/docs/blog/readme-maintenance.png index d5749606cc..a928b74229 100644 Binary files a/docs/src/content/docs/blog/readme-maintenance.png and b/docs/src/content/docs/blog/readme-maintenance.png differ diff --git a/docs/src/content/docs/blog/scripts-as-mcp-tools.png b/docs/src/content/docs/blog/scripts-as-mcp-tools.png index 99409696f1..9c83725175 100644 Binary files a/docs/src/content/docs/blog/scripts-as-mcp-tools.png and b/docs/src/content/docs/blog/scripts-as-mcp-tools.png differ diff --git a/docs/src/content/docs/blog/search-transform-genai.png b/docs/src/content/docs/blog/search-transform-genai.png index 19db0a9551..a336c48c27 100644 Binary files a/docs/src/content/docs/blog/search-transform-genai.png and b/docs/src/content/docs/blog/search-transform-genai.png differ diff --git a/docs/src/content/docs/blog/super-charge-copilot-chat.png b/docs/src/content/docs/blog/super-charge-copilot-chat.png index a5ddfafa31..e26a538c2f 100644 Binary files a/docs/src/content/docs/blog/super-charge-copilot-chat.png and b/docs/src/content/docs/blog/super-charge-copilot-chat.png differ diff --git a/docs/src/content/docs/blog/support-for-agentic-tools.png b/docs/src/content/docs/blog/support-for-agentic-tools.png index c51af8b8f6..c9d4efbe86 100644 Binary files a/docs/src/content/docs/blog/support-for-agentic-tools.png and b/docs/src/content/docs/blog/support-for-agentic-tools.png differ diff --git a/docs/src/content/docs/blog/video-introduction.png b/docs/src/content/docs/blog/video-introduction.png index 248abd53e6..74e44413bb 100644 Binary files a/docs/src/content/docs/blog/video-introduction.png and b/docs/src/content/docs/blog/video-introduction.png differ diff --git a/docs/src/content/docs/blog/video.png b/docs/src/content/docs/blog/video.png index 72ec3d729c..a596d31c61 100644 Binary files a/docs/src/content/docs/blog/video.png and b/docs/src/content/docs/blog/video.png differ diff --git a/docs/src/content/docs/blog/we-have-a-podcast.png b/docs/src/content/docs/blog/we-have-a-podcast.png index 2e4f7f19d0..c93e23970e 100644 Binary files a/docs/src/content/docs/blog/we-have-a-podcast.png and b/docs/src/content/docs/blog/we-have-a-podcast.png differ diff --git a/docs/src/content/docs/blog/webview.png b/docs/src/content/docs/blog/webview.png index f97be3a75f..33db3f882d 100644 Binary files a/docs/src/content/docs/blog/webview.png and b/docs/src/content/docs/blog/webview.png differ diff --git a/docs/src/content/docs/getting-started/automating-scripts.mdx b/docs/src/content/docs/getting-started/automating-scripts.mdx index 2f0c711e8b..15eb93a159 100644 --- a/docs/src/content/docs/getting-started/automating-scripts.mdx +++ b/docs/src/content/docs/getting-started/automating-scripts.mdx @@ -1,9 +1,19 @@ --- title: Automating scripts sidebar: - order: 5 -description: Learn how to automate your scripts using the GenAIScript CLI for efficient batch processing and integration into CI/CD pipelines. + order: 5 +description: Learn how to automate your scripts using the GenAIScript CLI for + efficient batch processing and integration into CI/CD pipelines. keywords: automation, CLI, batch processing, CI/CD integration, script execution +hero: + image: + alt: A simple, flat 8-bit icon displays a geometric laptop alongside a cogwheel + and checkmark, a stylized file tree linked by lines, a small cloud with an + upload arrow, and a basic shield representing security. All elements use a + five-color corporate palette, arranged on a transparent background in a + 128x128 pixel square, with no people, text, shadows, or 3D effects. + file: ./automating-scripts.png + --- import { Steps } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/getting-started/automating-scripts.png b/docs/src/content/docs/getting-started/automating-scripts.png new file mode 100644 index 0000000000..a8df3ca8ea Binary files /dev/null and b/docs/src/content/docs/getting-started/automating-scripts.png differ diff --git a/docs/src/content/docs/getting-started/best-practices.md b/docs/src/content/docs/getting-started/best-practices.md index d3ed97060f..19a6fc6489 100644 --- a/docs/src/content/docs/getting-started/best-practices.md +++ b/docs/src/content/docs/getting-started/best-practices.md @@ -3,7 +3,20 @@ title: Best Practices description: Suggestions for using GenAIScripts more effectively keywords: best practices, writing scripts sidebar: - order: 6 + order: 6 +hero: + image: + alt: A small, simple illustration using five solid colors shows rectangle icons + for scripts, each with symbols indicating parameters, arranged to appear + interconnected. There’s a plain document icon with a folded corner, and + two distinct file icons marked out by colored sections for PDF and DOCX + formats. Arrows connect these elements, illustrating the flow of input and + output between scripts. A cogwheel icon signals configuration, while two + overlapping speech bubble shapes symbolize different large language + models. All shapes are flat, iconic, and set on a blank, untextured + background with no people or written text. + file: ./best-practices.png + --- ## GenAIScript allows chatbot users to create reusable scripts diff --git a/docs/src/content/docs/getting-started/best-practices.png b/docs/src/content/docs/getting-started/best-practices.png new file mode 100644 index 0000000000..8b6cf85be0 Binary files /dev/null and b/docs/src/content/docs/getting-started/best-practices.png differ diff --git a/docs/src/content/docs/getting-started/configuration.mdx b/docs/src/content/docs/getting-started/configuration.mdx index 384f4bb6ea..8d29ed0b7c 100644 --- a/docs/src/content/docs/getting-started/configuration.mdx +++ b/docs/src/content/docs/getting-started/configuration.mdx @@ -1,9 +1,23 @@ --- title: Configuration -description: Set up your LLM connection and authorization with environment variables for seamless integration. -keywords: LLM setup, API configuration, environment variables, secure authorization, LLM integration +description: Set up your LLM connection and authorization with environment + variables for seamless integration. +keywords: LLM setup, API configuration, environment variables, secure + authorization, LLM integration sidebar: - order: 2 + order: 2 +hero: + image: + alt: A small, flat, 8-bit style illustration features simple colored blocks + linked by straight lines to depict API and cloud connections. Each block + displays a basic symbol, including representations of artificial + intelligence, a cloud, code, an environment file, and a lock for security. + Iconic, abstract shapes indicate major tech providers like OpenAI, Azure, + Google, Hugging Face, GitHub, and Anthropic. The arrangement is clear and + geometric, with each block in a unique color from a five-color palette, + all on a transparent background with no text, people, or visual effects. + file: ./configuration.png + --- import { FileTree } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/getting-started/configuration.png b/docs/src/content/docs/getting-started/configuration.png new file mode 100644 index 0000000000..8137ddbba8 Binary files /dev/null and b/docs/src/content/docs/getting-started/configuration.png differ diff --git a/docs/src/content/docs/getting-started/debugging-scripts.mdx b/docs/src/content/docs/getting-started/debugging-scripts.mdx index 50fc274712..a8137d0272 100644 --- a/docs/src/content/docs/getting-started/debugging-scripts.mdx +++ b/docs/src/content/docs/getting-started/debugging-scripts.mdx @@ -1,9 +1,21 @@ --- title: Debugging Scripts sidebar: - order: 4.5 -description: Learn how to debug GenAIScript files using Visual Studio Code Debugger to efficiently troubleshoot and enhance your JavaScript automation scripts. + order: 4.5 +description: Learn how to debug GenAIScript files using Visual Studio Code + Debugger to efficiently troubleshoot and enhance your JavaScript automation + scripts. keywords: debugging, JavaScript, Visual Studio Code, automation scripts, breakpoints +hero: + image: + alt: A simple 8-bit icon depicts a computer monitor displaying a code editor + with colored lines, a play button for running code, and a pause icon + indicating a breakpoint. A blue bug symbol in the corner represents + debugging, while a log file icon sits beside the window, and a gear icon + suggests settings. The design uses five flat corporate colors and + geometric shapes on a transparent background. + file: ./debugging-scripts.png + --- import { Image } from "astro:assets" diff --git a/docs/src/content/docs/getting-started/debugging-scripts.png b/docs/src/content/docs/getting-started/debugging-scripts.png new file mode 100644 index 0000000000..34e8b82c3d Binary files /dev/null and b/docs/src/content/docs/getting-started/debugging-scripts.png differ diff --git a/docs/src/content/docs/getting-started/index.mdx b/docs/src/content/docs/getting-started/index.mdx index d7d00fd514..ffea14cd8c 100644 --- a/docs/src/content/docs/getting-started/index.mdx +++ b/docs/src/content/docs/getting-started/index.mdx @@ -1,17 +1,28 @@ --- title: Getting Started sidebar: - order: 0 + order: 0 description: Start developing with the GenAIScript VS Code Extension to create - AI scripts efficiently. + AI scripts efficiently. keywords: - - AI Scripting Extension - - VS Code AI - - Generative AI Development - - AI Extension Setup - - AI Code Automation + - AI Scripting Extension + - VS Code AI + - Generative AI Development + - AI Extension Setup + - AI Code Automation genaiscript: - files: src/samples/markdown-small.txt + files: src/samples/markdown-small.txt +hero: + image: + alt: An abstract pixelated 8-bit style icon features a blocky computer screen + with colorful squares symbolizing code. Arranged beside it are a chat + bubble for conversation, a simple document file, and a gear for tools. A + small spark shape suggests automation or AI. The design uses five solid + colors, has a flat and corporate appearance, and lacks any people, text, + background elements, or visual effects like shadows, gradients, or + reflections. The overall layout is 128 by 128 pixels. + file: ./index.png + --- import { YouTube } from 'astro-embed'; diff --git a/docs/src/content/docs/getting-started/index.png b/docs/src/content/docs/getting-started/index.png new file mode 100644 index 0000000000..84b5cc8ece Binary files /dev/null and b/docs/src/content/docs/getting-started/index.png differ diff --git a/docs/src/content/docs/getting-started/installation.mdx b/docs/src/content/docs/getting-started/installation.mdx index 52e38675e0..564c257dcc 100644 --- a/docs/src/content/docs/getting-started/installation.mdx +++ b/docs/src/content/docs/getting-started/installation.mdx @@ -1,9 +1,22 @@ --- title: Installation sidebar: - order: 1 -description: Learn how to install GenAIScript as a Visual Studio Code extension or use it via command line for seamless integration into your development workflow. -keywords: Visual Studio Code, GenAIScript extension, command line tool, manual installation, Node.js + order: 1 +description: Learn how to install GenAIScript as a Visual Studio Code extension + or use it via command line for seamless integration into your development + workflow. +keywords: Visual Studio Code, GenAIScript extension, command line tool, manual + installation, Node.js +hero: + image: + alt: A simple and colorful flat 2D image shows a geometric computer screen with + the Visual Studio Code logo, next to a small 8-bit style terminal window + marked by the Node.js logo, and a stylized folder tree highlighting a + .vsix file box. The design uses only five bright corporate colors, lacks + background, people, or text, and features only iconic shapes with no + shadows or gradients in a compact square format. + file: ./installation.png + --- import { Image } from "astro:assets" diff --git a/docs/src/content/docs/getting-started/installation.png b/docs/src/content/docs/getting-started/installation.png new file mode 100644 index 0000000000..b2f56c1e2a Binary files /dev/null and b/docs/src/content/docs/getting-started/installation.png differ diff --git a/docs/src/content/docs/getting-started/running-scripts.mdx b/docs/src/content/docs/getting-started/running-scripts.mdx index 04d5773735..5ba400f6e2 100644 --- a/docs/src/content/docs/getting-started/running-scripts.mdx +++ b/docs/src/content/docs/getting-started/running-scripts.mdx @@ -1,9 +1,24 @@ --- title: Running scripts -description: Discover how to run scripts in your development environment, manage script execution, and interpret the results for enhanced productivity. -keywords: script execution, script management, result analysis, development automation, script workflow +description: Discover how to run scripts in your development environment, manage + script execution, and interpret the results for enhanced productivity. +keywords: script execution, script management, result analysis, development + automation, script workflow sidebar: - order: 4 + order: 4 +hero: + image: + alt: "A minimal 8-bit style icon: on the left is a simple file explorer window + with stacked rectangles representing folders and a highlighted single + file; on the right is a basic command line window, centered with a bright + triangle play button. Above these, a plain scroll suggests a code script + and a square ticked checkbox suggests a task. A small magnifying glass and + a gear icon are present for analysis and settings. The image uses five + flat corporate colors, features only basic geometric shapes without + background, people, text, gradients, shadows, or 3D effects, and is sized + at 128x128 pixels." + file: ./running-scripts.png + --- import { YouTube } from "astro-embed" diff --git a/docs/src/content/docs/getting-started/running-scripts.png b/docs/src/content/docs/getting-started/running-scripts.png new file mode 100644 index 0000000000..dada08c889 Binary files /dev/null and b/docs/src/content/docs/getting-started/running-scripts.png differ diff --git a/docs/src/content/docs/getting-started/testing-scripts.mdx b/docs/src/content/docs/getting-started/testing-scripts.mdx index 870632753e..c4e674f13a 100644 --- a/docs/src/content/docs/getting-started/testing-scripts.mdx +++ b/docs/src/content/docs/getting-started/testing-scripts.mdx @@ -1,9 +1,20 @@ --- title: Testing scripts sidebar: - order: 4.6 -description: Learn how to declare and run tests for your scripts to ensure their correctness and reliability. + order: 4.6 +description: Learn how to declare and run tests for your scripts to ensure their + correctness and reliability. keywords: testing, scripts, validation, GenAIScript CLI, automation +hero: + image: + alt: A simple pixelated image displays a geometric computer monitor with three + distinct colored rectangles, a file icon, and a checklist icon. A dotted + line visually connects the file, checklist, and colored model options. The + design uses five clear corporate colors on a flat, plain background, with + no text, people, or shading. The style is 8-bit and highly simplified at a + small scale. + file: ./testing-scripts.png + --- import { Image } from "astro:assets" diff --git a/docs/src/content/docs/getting-started/testing-scripts.png b/docs/src/content/docs/getting-started/testing-scripts.png new file mode 100644 index 0000000000..2176a276da Binary files /dev/null and b/docs/src/content/docs/getting-started/testing-scripts.png differ diff --git a/docs/src/content/docs/getting-started/tutorial.md b/docs/src/content/docs/getting-started/tutorial.md index 16ba05600d..66552f6696 100644 --- a/docs/src/content/docs/getting-started/tutorial.md +++ b/docs/src/content/docs/getting-started/tutorial.md @@ -1,9 +1,20 @@ --- title: Tutorial Notebook sidebar: - order: 100 -description: Learn how to use GenAIScript with this interactive tutorial notebook featuring executable JavaScript code blocks. + order: 100 +description: Learn how to use GenAIScript with this interactive tutorial + notebook featuring executable JavaScript code blocks. keywords: tutorial, GenAIScript notebook, interactive learning, JavaScript, markdown +hero: + image: + alt: A simple 2D illustration uses geometric shapes to depict a computer screen + displaying code blocks, alongside icons for files and chat messages. It + features a recognizable script symbol, a document marked with hashtag and + asterisk symbols, and a magic wand or spark conveying automation. The + color scheme is limited to five bold corporate tones, with no people or + background, and follows a flat, 8-bit style at small size. + file: ./tutorial.png + --- This Notebook is a GenAIScript tutorial. It is a Markdown document where each JavaScript code section is a runnable GenAIScript. You can execute each code block individually and see the results in the output section below the code block. To open this notebook in Visual Studio Code, press **F1** and run **GenAIScript: Create GenAIScript Markdown Notebook**. diff --git a/docs/src/content/docs/getting-started/tutorial.png b/docs/src/content/docs/getting-started/tutorial.png new file mode 100644 index 0000000000..6ec669279b Binary files /dev/null and b/docs/src/content/docs/getting-started/tutorial.png differ diff --git a/docs/src/content/docs/getting-started/your-first-genai-script.mdx b/docs/src/content/docs/getting-started/your-first-genai-script.mdx index 58b6d40c1d..548ff7bb5a 100644 --- a/docs/src/content/docs/getting-started/your-first-genai-script.mdx +++ b/docs/src/content/docs/getting-started/your-first-genai-script.mdx @@ -1,13 +1,26 @@ --- title: Your first GenAI script sidebar: - order: 3 + order: 3 description: Learn how to create and execute your initial GenAI script to - automate interactions with language models. + automate interactions with language models. keywords: GenAI script creation, language model automation, script execution, - LLM prompt generation, genaisrc setup + LLM prompt generation, genaisrc setup genaiscript: - files: src/samples/markdown.md + files: src/samples/markdown.md +hero: + image: + alt: A clean, pixel-art style image shows a geometric file folder holding + several colored file icons, with one icon visibly highlighted as if + selected. Nearby are stylized shapes representing documents, a code + symbol, a prompt box displaying a sample poem line, and simple icons + including a pen and a check mark suggesting proofreading tools. Abstract + interface elements hint at creating prompts and running scripts. The + artwork uses flat blue, yellow, green, orange, and gray shapes on a plain + white background, without any shadows, people, or actual text. The + composition is simple and compact, fitting a small square format. + file: ./your-first-genai-script.png + --- import { Tabs, TabItem } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/getting-started/your-first-genai-script.png b/docs/src/content/docs/getting-started/your-first-genai-script.png new file mode 100644 index 0000000000..30bcb39d50 Binary files /dev/null and b/docs/src/content/docs/getting-started/your-first-genai-script.png differ diff --git a/docs/src/content/docs/reference/api/index.mdx b/docs/src/content/docs/reference/api/index.mdx index 3b5c7ff0e0..a460b5e0b0 100644 --- a/docs/src/content/docs/reference/api/index.mdx +++ b/docs/src/content/docs/reference/api/index.mdx @@ -11,6 +11,15 @@ keywords: - API integration - environment variables - script execution +hero: + image: + alt: "A minimal 8-bit style graphic shows a geometric computer screen or code + editor next to a gear, symbolizing a Node.js setup. Around them are simple + flat icons: a cube for packages, an arrow representing API imports, and a + circular loop for worker threads or process spawning. The design uses only + five bold corporate colors on a white background, with no people, text, + gradients, or shadows, at a size of 128 by 128 pixels." + file: ./index.png --- diff --git a/docs/src/content/docs/reference/api/index.png b/docs/src/content/docs/reference/api/index.png new file mode 100644 index 0000000000..86ae96cbd0 Binary files /dev/null and b/docs/src/content/docs/reference/api/index.png differ diff --git a/docs/src/content/docs/reference/cli/commands.md b/docs/src/content/docs/reference/cli/commands.md index b3e265301b..ed41b6b821 100644 --- a/docs/src/content/docs/reference/cli/commands.md +++ b/docs/src/content/docs/reference/cli/commands.md @@ -3,6 +3,16 @@ title: Commands description: List of all CLI commands sidebar: order: 100 +hero: + image: + alt: "A 2D 8-bit style illustration made with flat geometric shapes in five + colors, featuring interlocking icons: document scripts, gears, file + folders, command line terminals, a brain with circuits for AI, stacked + disks for data, a server/cloud, and a filmstrip for video. The design is + corporate and minimal, with no text, people, or background, sized at + 128x128 pixels." + file: ./commands.png + --- diff --git a/docs/src/content/docs/reference/cli/commands.png b/docs/src/content/docs/reference/cli/commands.png new file mode 100644 index 0000000000..b324bdbea9 Binary files /dev/null and b/docs/src/content/docs/reference/cli/commands.png differ diff --git a/docs/src/content/docs/reference/cli/configure.mdx b/docs/src/content/docs/reference/cli/configure.mdx index 0ec56edd4b..652e5aa8bf 100644 --- a/docs/src/content/docs/reference/cli/configure.mdx +++ b/docs/src/content/docs/reference/cli/configure.mdx @@ -2,7 +2,17 @@ title: Configure description: Configure and validate the LLM connections. sidebar: - order: 4 + order: 4 +hero: + image: + alt: An 8-bit style computer terminal is depicted alongside a gear and network + node icons, using a flat 2D geometric design with only five distinct + colors. The image is small, at 128 by 128 pixels, and completely avoids + people, text, shadows, gradients, reflections, backgrounds, or any + three-dimensional effects. The composition suggests themes of computer + configuration and network connectivity. + file: ./configure.png + --- Interactive command to configure and validate the LLM connections. diff --git a/docs/src/content/docs/reference/cli/configure.png b/docs/src/content/docs/reference/cli/configure.png new file mode 100644 index 0000000000..50db223288 Binary files /dev/null and b/docs/src/content/docs/reference/cli/configure.png differ diff --git a/docs/src/content/docs/reference/cli/convert.mdx b/docs/src/content/docs/reference/cli/convert.mdx index 4dc1cf91e2..b04b09ed51 100644 --- a/docs/src/content/docs/reference/cli/convert.mdx +++ b/docs/src/content/docs/reference/cli/convert.mdx @@ -2,8 +2,21 @@ title: Convert description: Learn how to apply a script to many files and extract the output. sidebar: - order: 2 -keywords: CLI tool execution, genai script running, stdout streaming, file globing, environment configuration + order: 2 +keywords: CLI tool execution, genai script running, stdout streaming, file + globing, environment configuration +hero: + image: + alt: An illustration featuring an 8-bit style terminal icon, surrounded by + colorful minimalist file icons that symbolize markdown, TypeScript, and + text documents. These files flow through a geometric icon resembling a + script tool, such as a gear or magic wand, with prominent arrows showing + the transformation process. On the other side, new file icons appear, each + displaying bold suffixes to indicate conversion. The entire scene uses a + simple, flat design with only five colors on a clean white or transparent + background, without any human figures or text. + file: ./convert.png + --- Converts a set of files, separately, using a script. diff --git a/docs/src/content/docs/reference/cli/convert.png b/docs/src/content/docs/reference/cli/convert.png new file mode 100644 index 0000000000..550c2e644d Binary files /dev/null and b/docs/src/content/docs/reference/cli/convert.png differ diff --git a/docs/src/content/docs/reference/cli/index.mdx b/docs/src/content/docs/reference/cli/index.mdx index dd41713611..20aa4ff0a1 100644 --- a/docs/src/content/docs/reference/cli/index.mdx +++ b/docs/src/content/docs/reference/cli/index.mdx @@ -1,9 +1,23 @@ --- title: Overview sidebar: - order: 1 -description: Comprehensive guide to using the GenAIScript CLI for automating tasks with AI scripts in Node.js environments. -keywords: GenAIScript CLI, Node.js automation, AI scripting, command line interface, JavaScript automation + order: 1 +description: Comprehensive guide to using the GenAIScript CLI for automating + tasks with AI scripts in Node.js environments. +keywords: GenAIScript CLI, Node.js automation, AI scripting, command line + interface, JavaScript automation +hero: + image: + alt: A small, pixelated 2D illustration features a geometric laptop with a + screen showing Node.js and npm icons alongside a cogwheel, symbolizing + development tools. Script files are placed nearby, while a cloud icon + represents proxy and environment configuration. Polygonal arrows flow + between the elements, indicating command execution and automation. The + entire scene uses five solid corporate colors, fits within a 128x128 pixel + frame, and has a flat, minimalistic pixel art style with no background, + shadows, humans, or text. + file: ./index.png + --- import { Steps } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/cli/index.png b/docs/src/content/docs/reference/cli/index.png new file mode 100644 index 0000000000..5ecbdc9f1d Binary files /dev/null and b/docs/src/content/docs/reference/cli/index.png differ diff --git a/docs/src/content/docs/reference/cli/run.mdx b/docs/src/content/docs/reference/cli/run.mdx index c9e189a1e0..003032b456 100644 --- a/docs/src/content/docs/reference/cli/run.mdx +++ b/docs/src/content/docs/reference/cli/run.mdx @@ -1,9 +1,24 @@ --- title: Run -description: Learn how to execute genai scripts on files with streaming output to stdout, including usage of glob patterns, environment variables, and output options. +description: Learn how to execute genai scripts on files with streaming output + to stdout, including usage of glob patterns, environment variables, and output + options. sidebar: - order: 1 -keywords: CLI tool execution, genai script running, stdout streaming, file globing, environment configuration + order: 1 +keywords: CLI tool execution, genai script running, stdout streaming, file + globing, environment configuration +hero: + image: + alt: An abstract 8-bit style illustration depicts a colorful terminal window + featuring a simple gear, a cloud, and a document icon, all rendered in + bold, flat geometric shapes. Multiple file icons with glowing outlines + overlap each other, accompanied by a small branching arrow symbolizing a + pipeline, and a stylized folder icon. The color palette uses five + distinct, bold corporate colors, and the image is strictly 2D, without + background, text, shadows, or gradients. The layout is compact, sized at + 128 by 128 pixels. + file: ./run.png + --- Runs a script on files and streams the LLM output to stdout or a folder from the workspace root. diff --git a/docs/src/content/docs/reference/cli/run.png b/docs/src/content/docs/reference/cli/run.png new file mode 100644 index 0000000000..c45a8f7dfe Binary files /dev/null and b/docs/src/content/docs/reference/cli/run.png differ diff --git a/docs/src/content/docs/reference/cli/serve.md b/docs/src/content/docs/reference/cli/serve.md index bcb7f932c8..f0d7bc25ee 100644 --- a/docs/src/content/docs/reference/cli/serve.md +++ b/docs/src/content/docs/reference/cli/serve.md @@ -2,7 +2,17 @@ title: Serve description: Launch local web server. sidebar: - order: 2 + order: 2 +hero: + image: + alt: A simple 2D server icon in 8-bit style features a computer tower and a + globe representing network connectivity. Color-coded buttons indicate API + functions, accompanied by a shield symbol for API key security, a gear + icon for settings, and an abstract chain to represent CORS. The icon uses + a five-color flat corporate palette, fits within a 128x128 frame, has a + transparent background, and includes no text, people, or shadows. + file: ./serve.png + --- Launch a local web server that is used to run the playground diff --git a/docs/src/content/docs/reference/cli/serve.png b/docs/src/content/docs/reference/cli/serve.png new file mode 100644 index 0000000000..a256f50a51 Binary files /dev/null and b/docs/src/content/docs/reference/cli/serve.png differ diff --git a/docs/src/content/docs/reference/cli/test.mdx b/docs/src/content/docs/reference/cli/test.mdx index c48410d7bb..171dccc751 100644 --- a/docs/src/content/docs/reference/cli/test.mdx +++ b/docs/src/content/docs/reference/cli/test.mdx @@ -2,8 +2,20 @@ title: Test sidebar: order: 3.5 -description: Learn how to run tests for your scripts using GenAIScript CLI with support for multiple AI models. +description: Learn how to run tests for your scripts using GenAIScript CLI with + support for multiple AI models. keywords: CLI testing, script tests, AI model testing, test viewer, GenAIScript CLI +hero: + image: + alt: A simple 8-bit style image shows a computer monitor with vibrant colorful + blocks depicting different scripts and compact server icons that indicate + code tests. Two geometric, cloud-like shapes float nearby, suggesting AI + models. A small magnifying glass icon is present to represent the action + of viewing results. The palette includes five distinct corporate colors, + all visual elements are flat and geometric, no people or backgrounds are + visible, and the image is sized at 128 by 128 pixels. + file: ./test.png + --- Runs the tests in scripts using [promptfoo](https://www.promptfoo.dev/). diff --git a/docs/src/content/docs/reference/cli/test.png b/docs/src/content/docs/reference/cli/test.png new file mode 100644 index 0000000000..b07610c1fb Binary files /dev/null and b/docs/src/content/docs/reference/cli/test.png differ diff --git a/docs/src/content/docs/reference/cli/video.mdx b/docs/src/content/docs/reference/cli/video.mdx index 09734c12c6..d4c5800517 100644 --- a/docs/src/content/docs/reference/cli/video.mdx +++ b/docs/src/content/docs/reference/cli/video.mdx @@ -2,8 +2,18 @@ title: Video description: Learn about various video-related command sidebar: - order: 3 -keywords: CLI tool execution, genai script running, stdout streaming, file globing, environment configuration + order: 3 +keywords: CLI tool execution, genai script running, stdout streaming, file + globing, environment configuration +hero: + image: + alt: A small, flat, geometric video player rectangle sits at the center, with + four simple 8-bit icons—film strip, speaker, waveform, and + clock—positioned near each corner. Each icon uses a solid color and basic + shapes. The image has no background, text, or people, and uses only five + corporate color tones in a minimal, retro 128x128 pixel style. + file: ./video.png + --- Some of the [video processing capabilities](/genaiscript/reference/scripts/videos) are also available in the cli. diff --git a/docs/src/content/docs/reference/cli/video.png b/docs/src/content/docs/reference/cli/video.png new file mode 100644 index 0000000000..65d7134d20 Binary files /dev/null and b/docs/src/content/docs/reference/cli/video.png differ diff --git a/docs/src/content/docs/reference/configuration-files.mdx b/docs/src/content/docs/reference/configuration-files.mdx index 07200be28d..59012e16b3 100644 --- a/docs/src/content/docs/reference/configuration-files.mdx +++ b/docs/src/content/docs/reference/configuration-files.mdx @@ -2,7 +2,18 @@ title: Configuration Files description: Learn how to configure common configuration settings using configuration files sidebar: - order: 90 + order: 90 +hero: + image: + alt: "An 8-bit style illustration features four colored squares stacked to + represent different types of files such as .env and config files. Each + square shows a unique icon: a keyhole for secrets, a spark for scripts, a + gear for configuration, and a chain link for include files. Above the + stack, a swirling line connects them, suggesting the merging or combining + of these files. The design is simple, minimal, uses five flat colors, and + has no people or background elements." + file: ./configuration-files.png + --- import { Code } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/configuration-files.png b/docs/src/content/docs/reference/configuration-files.png new file mode 100644 index 0000000000..a89270099d Binary files /dev/null and b/docs/src/content/docs/reference/configuration-files.png differ diff --git a/docs/src/content/docs/reference/index.md b/docs/src/content/docs/reference/index.md index df9ff44137..8afeff9f39 100644 --- a/docs/src/content/docs/reference/index.md +++ b/docs/src/content/docs/reference/index.md @@ -1,9 +1,22 @@ --- title: Overview -description: Comprehensive documentation for scripting automation, LLM configurations, and developer tools including a VSCode extension and CLI for codebase AI transformations. +description: Comprehensive documentation for scripting automation, LLM + configurations, and developer tools including a VSCode extension and CLI for + codebase AI transformations. keywords: scripting automation, LLM configurations, VSCode extension, CLI, codebase AI sidebar: - order: 0 + order: 0 +hero: + image: + alt: "A circular arrangement of five 8-bit style icons on a plain background: a + scroll with code brackets for scripting, a glowing AI brain chip for + artificial intelligence, a simple gear for command line interface, a + minimalist laptop with a magic wand symbolizing a VSCode extension, and a + row of basic blocks illustrating workflow automation. Each icon uses only + five distinct corporate colors and is rendered with flat, minimal + geometric shapes." + file: ./index.png + --- GenAIScript is a scripting language that makes LLMs a first-class part of the scripting process, easily allowing users to author, debug, and deploy LLM-based scripts that can perform tasks beyond the reach of conventional code. This reference guide provides comprehensive documentation for GenAIScripts, including script syntax, LLM configurations, the VSCode extension, and the CLI. diff --git a/docs/src/content/docs/reference/index.png b/docs/src/content/docs/reference/index.png new file mode 100644 index 0000000000..b0ed332bcc Binary files /dev/null and b/docs/src/content/docs/reference/index.png differ diff --git a/docs/src/content/docs/reference/playground.mdx b/docs/src/content/docs/reference/playground.mdx index 10f5e2182b..1200c08780 100644 --- a/docs/src/content/docs/reference/playground.mdx +++ b/docs/src/content/docs/reference/playground.mdx @@ -1,8 +1,19 @@ --- title: Playground -description: Describe how to use the local server playground to launch scripts from a user interface. +description: Describe how to use the local server playground to launch scripts + from a user interface. sidebar: - order: 10 + order: 10 +hero: + image: + alt: A minimalistic 8-bit style icon shows a computer monitor with a web browser + displaying code, over which large gear and folder icons appear. Beside the + monitor, a stylized cloud features a branching git symbol, and a simple + command line icon is included. All elements use flat geometric shapes, a + five-color palette, and no additional background or shadows. The overall + look is clean, iconic, and fits in a small square space. + file: ./playground.png + --- import { Image } from "astro:assets" diff --git a/docs/src/content/docs/reference/playground.png b/docs/src/content/docs/reference/playground.png new file mode 100644 index 0000000000..200a9f4b5e Binary files /dev/null and b/docs/src/content/docs/reference/playground.png differ diff --git a/docs/src/content/docs/reference/scripts/agents.mdx b/docs/src/content/docs/reference/scripts/agents.mdx index 0617359548..8b3deb013a 100644 --- a/docs/src/content/docs/reference/scripts/agents.mdx +++ b/docs/src/content/docs/reference/scripts/agents.mdx @@ -1,8 +1,18 @@ --- title: Agents -description: An Agent is a tool that queries an LLM, equipped with other tools, to accomplish tasks. +description: An Agent is a tool that queries an LLM, equipped with other tools, + to accomplish tasks. sidebar: - order: 7.1 + order: 7.1 +hero: + image: + alt: A flat 8-bit style illustration displays a central large geometric chip + marked as "LLM," two smaller gears above and right to represent tools, and + a simple rectangle below indicating memory. Thin lines connect these + elements, arranged symmetrically, all in five corporate colors, using only + basic shapes. There are no backgrounds, people, extra details, or shadows. + file: ./agents.png + --- import { Code } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/scripts/agents.png b/docs/src/content/docs/reference/scripts/agents.png new file mode 100644 index 0000000000..36c8835e16 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/agents.png differ diff --git a/docs/src/content/docs/reference/scripts/annotations.md b/docs/src/content/docs/reference/scripts/annotations.md index fd5ba00e8b..61de4e5e12 100644 --- a/docs/src/content/docs/reference/scripts/annotations.md +++ b/docs/src/content/docs/reference/scripts/annotations.md @@ -1,9 +1,21 @@ --- title: Annotations -description: Learn how to add annotations such as errors, warnings, or notes to LLM output for integration with VSCode or CI environments. +description: Learn how to add annotations such as errors, warnings, or notes to + LLM output for integration with VSCode or CI environments. keywords: annotations, LLM output, VSCode integration, CI environment, GitHub Actions sidebar: - order: 11 + order: 11 +hero: + image: + alt: "A simple 8-bit style icon shows a blocky computer monitor with a piece of + code displayed, overlaid by three symbols: a red triangle signaling an + error, a yellow exclamation for warning, and a blue note. Next to the + monitor, flat colored squares symbolize integration points for GitHub, + VSCode, and a checklist, all designed with basic geometric shapes and + limited to five distinct colors. The scene has no background or human + figures." + file: ./annotations.png + --- Annotations are errors, warnings, or notes that can be added to the LLM output. They are extracted and integrated into VSCode or your CI environment. diff --git a/docs/src/content/docs/reference/scripts/annotations.png b/docs/src/content/docs/reference/scripts/annotations.png new file mode 100644 index 0000000000..3de4036d13 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/annotations.png differ diff --git a/docs/src/content/docs/reference/scripts/ast-grep.mdx b/docs/src/content/docs/reference/scripts/ast-grep.mdx index 34c898159f..6fa8d8fb52 100644 --- a/docs/src/content/docs/reference/scripts/ast-grep.mdx +++ b/docs/src/content/docs/reference/scripts/ast-grep.mdx @@ -2,7 +2,19 @@ title: ast-grep description: Search for patterns in the AST of a script sidebar: - order: 20 + order: 20 +hero: + image: + alt: An abstract, 8-bit style image featuring several bold, geometric code block + shapes overlapping within a 128x128 pixel space, each shape in one of five + distinct colors. Select blocks contain minimal, branching line patterns + evoking nodes of an abstract syntax tree. Thin connectors link some + blocks, suggesting searching and transformation between nodes. Small, + crisp programming icons—such as a curly bracket, a 'py' for Python, and a + diamond for SQL—are embedded within some shapes. The scene is entirely + flat, 2D, with sharp, clean edges, no background, and no human figures. + file: ./ast-grep.png + --- [ast-grep](https://ast-grep.github.io/) is a fast and polyglot tool for code structural search, lint, rewriting at large scale. diff --git a/docs/src/content/docs/reference/scripts/ast-grep.png b/docs/src/content/docs/reference/scripts/ast-grep.png new file mode 100644 index 0000000000..67eda7500a Binary files /dev/null and b/docs/src/content/docs/reference/scripts/ast-grep.png differ diff --git a/docs/src/content/docs/reference/scripts/browser.md b/docs/src/content/docs/reference/scripts/browser.md index cb2a817e62..883e323760 100644 --- a/docs/src/content/docs/reference/scripts/browser.md +++ b/docs/src/content/docs/reference/scripts/browser.md @@ -1,15 +1,24 @@ --- title: Browser Automation sidebar: - order: 30 + order: 30 description: Discover how GenAIScript integrates with Playwright for web - scraping and browser automation tasks. + scraping and browser automation tasks. tags: - - GenAIScript - - Playwright - - web scraping - - automation - - browser + - GenAIScript + - Playwright + - web scraping + - automation + - browser +hero: + image: + alt: A bold, minimalistic 8-bit icon features a web browser window with a basic + table of columns and rows, a floating geometric film strip and play button + to indicate video recording, a gear for automation, and a diamond or + chevron for data parsing. The image uses five corporate colors, has flat, + simple shapes, no people or text, and a transparent background. + file: ./browser.png + --- GenAIScript provides a simplified API to interact with a headless browser using [Playwright](https://playwright.dev/) . diff --git a/docs/src/content/docs/reference/scripts/browser.png b/docs/src/content/docs/reference/scripts/browser.png new file mode 100644 index 0000000000..5383327bab Binary files /dev/null and b/docs/src/content/docs/reference/scripts/browser.png differ diff --git a/docs/src/content/docs/reference/scripts/cache.mdx b/docs/src/content/docs/reference/scripts/cache.mdx index db90aea089..0d85b425f2 100644 --- a/docs/src/content/docs/reference/scripts/cache.mdx +++ b/docs/src/content/docs/reference/scripts/cache.mdx @@ -1,9 +1,21 @@ --- title: Cache sidebar: - order: 15 -description: Learn how LLM requests are cached in scripts to optimize performance and how to manage cache settings. -keywords: cache management, LLM request caching, script performance, cache file customization, cache disabling + order: 15 +description: Learn how LLM requests are cached in scripts to optimize + performance and how to manage cache settings. +keywords: cache management, LLM request caching, script performance, cache file + customization, cache disabling +hero: + image: + alt: A simple 8-bit icon displays a gray folder marked as ".genaiscript," + holding two rectangular file icons, one blue labeled "chat.jsonl" and one + yellow labeled "summary.jsonl." The design uses flat, geometric shapes in + gray, blue, yellow, black, and white, focusing solely on the folder and + files to visually represent software caching, with no background or + additional elements. + file: ./cache.png + --- import { FileTree } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/scripts/cache.png b/docs/src/content/docs/reference/scripts/cache.png new file mode 100644 index 0000000000..e1e944909e Binary files /dev/null and b/docs/src/content/docs/reference/scripts/cache.png differ diff --git a/docs/src/content/docs/reference/scripts/cancel.md b/docs/src/content/docs/reference/scripts/cancel.md index 9b3e0f7f16..d374319ee6 100644 --- a/docs/src/content/docs/reference/scripts/cancel.md +++ b/docs/src/content/docs/reference/scripts/cancel.md @@ -2,8 +2,18 @@ title: Cancel sidebar: order: 15 -description: Learn how to immediately stop script execution with the cancel function in your automation scripts. +description: Learn how to immediately stop script execution with the cancel + function in your automation scripts. keywords: cancel function, script termination, stop execution, automation, script control +hero: + image: + alt: A small, pixelated computer screen displays a prominent red stop button, + next to a simple script document marked with a cancel X, and an empty file + tray, all rendered in flat 8-bit style with just five distinct colors, no + people, no background, and no visible text. The composition gives a clean, + symbolic sense of halted tasks and inactivity. + file: ./cancel.png + --- It is not uncommon that upon executing a script, you may want to cancel the execution of the script. This can be done using the `cancel` function. The `cancel` function takes an optional `reason` argument and will immediately stop the execution of the script. diff --git a/docs/src/content/docs/reference/scripts/cancel.png b/docs/src/content/docs/reference/scripts/cancel.png new file mode 100644 index 0000000000..f34b228001 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/cancel.png differ diff --git a/docs/src/content/docs/reference/scripts/cast.md b/docs/src/content/docs/reference/scripts/cast.md index c866543d33..6c046f4a72 100644 --- a/docs/src/content/docs/reference/scripts/cast.md +++ b/docs/src/content/docs/reference/scripts/cast.md @@ -1,8 +1,20 @@ --- -title: "Cast" -description: "Use the cast helper to convert text to structured data" +title: Cast +description: Use the cast helper to convert text to structured data sidebar: - order: 80 + order: 80 +hero: + image: + alt: A flat, minimalist 8-bit illustration at a size of 128x128 pixels displays + a geometric file folder containing structured data sheets, each shown as + rectangles with horizontal lines. These sheets emerge from a vivid, + abstract text block and a simple image icon. Surrounding the folder are + clean, minimal circuit or chip symbols indicating AI, along with lines or + shapes representing data connections. The entire image is created using + just five distinct corporate colors and lacks any background, shadows, or + gradients. + file: ./cast.png + --- The `cast` function in GenAIScript allows you to convert text or images to structured data. diff --git a/docs/src/content/docs/reference/scripts/cast.png b/docs/src/content/docs/reference/scripts/cast.png new file mode 100644 index 0000000000..93280f0829 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/cast.png differ diff --git a/docs/src/content/docs/reference/scripts/chat-participants.mdx b/docs/src/content/docs/reference/scripts/chat-participants.mdx index 90c34ac77f..df47c4a25c 100644 --- a/docs/src/content/docs/reference/scripts/chat-participants.mdx +++ b/docs/src/content/docs/reference/scripts/chat-participants.mdx @@ -1,10 +1,18 @@ --- title: Chat Participants sidebar: - order: 50 + order: 50 description: Create multi-turn chats or simulate conversations with multiple - chat participants + chat participants keywords: chat, multi-turn, conversation, chat participant, engagement +hero: + image: + alt: A simple 8-bit chat interface made of geometric speech bubbles in a + repeating Q&A sequence, all in flat bold colors. One bubble stands out + with an arrow signifying a rewrite. No text, people, or decoration, just + clean 2D shapes on a blank background. + file: ./chat-participants.png + --- import { Code } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/scripts/chat-participants.png b/docs/src/content/docs/reference/scripts/chat-participants.png new file mode 100644 index 0000000000..92c1e6f028 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/chat-participants.png differ diff --git a/docs/src/content/docs/reference/scripts/choices.md b/docs/src/content/docs/reference/scripts/choices.md index eed6d15085..17e5c1584c 100644 --- a/docs/src/content/docs/reference/scripts/choices.md +++ b/docs/src/content/docs/reference/scripts/choices.md @@ -3,7 +3,16 @@ title: Choices description: Specify a list of preferred token choices for a script. keywords: choices, preferred words, logit bias sidebar: - order: 20 + order: 20 +hero: + image: + alt: 'An image in 8-bit minimalist style shows two flat-colored square tokens: + one with a checkmark symbolizing "OK", and one with an "X" for "ERR". The + squares are joined by lines indicating adjustment or transition between + states. The design uses five distinct colors, features bold, basic shapes, + and has no text, people, or background details.' + file: ./choices.png + --- You can specify a list of preferred words (choices) in the script metadata. It will increase the probability of the model generating the specified words. diff --git a/docs/src/content/docs/reference/scripts/choices.png b/docs/src/content/docs/reference/scripts/choices.png new file mode 100644 index 0000000000..7fc9c79ff6 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/choices.png differ diff --git a/docs/src/content/docs/reference/scripts/classify.md b/docs/src/content/docs/reference/scripts/classify.md index d5972c837b..79b4baa29b 100644 --- a/docs/src/content/docs/reference/scripts/classify.md +++ b/docs/src/content/docs/reference/scripts/classify.md @@ -1,8 +1,19 @@ --- -title: "Classify" -description: "Use the classify helpers for your classification tasks" +title: Classify +description: Use the classify helpers for your classification tasks sidebar: - order: 80 + order: 80 +hero: + image: + alt: Three simple, brightly colored geometric boxes, each labeled with either + "bug," "feature," or "qa," arranged in a corporate flat 8-bit art style. + Above the boxes, abstract interconnected lines suggest AI or neural + network analysis and a small digital bar shows classification probability. + One box stands out as highlighted, indicating it has been selected. The + image is small, uses only five bold colors, minimal shapes, and has no + background, shadows, or people. + file: ./classify.png + --- The `classify` function in GenAIScript allows you to categorize inputs based on a machine learning model. diff --git a/docs/src/content/docs/reference/scripts/classify.png b/docs/src/content/docs/reference/scripts/classify.png new file mode 100644 index 0000000000..87a06fd384 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/classify.png differ diff --git a/docs/src/content/docs/reference/scripts/concurrency.md b/docs/src/content/docs/reference/scripts/concurrency.md index c49c011c2d..b2c1af8730 100644 --- a/docs/src/content/docs/reference/scripts/concurrency.md +++ b/docs/src/content/docs/reference/scripts/concurrency.md @@ -2,7 +2,18 @@ title: Concurrency description: How to run multiple prompts concurrently sidebar: - order: 50 + order: 50 +hero: + image: + alt: A minimalist 2D 8-bit image depicts three colored geometric boxes, + symbolizing promises, advancing side by side on a horizontal conveyor belt + with three lanes, and each sliding into separate square slots that + represent concurrent execution. Additional boxes form a queue, ready to + enter the belt. The design is flat, geometric, uses only five colors, has + no characters, background, or shadows, and maintains a small, iconic + appearance. + file: ./concurrency.png + --- When working with GenAI, your program will likely be idle, waiting for tokens to return from the LLM. diff --git a/docs/src/content/docs/reference/scripts/concurrency.png b/docs/src/content/docs/reference/scripts/concurrency.png new file mode 100644 index 0000000000..81bf74646f Binary files /dev/null and b/docs/src/content/docs/reference/scripts/concurrency.png differ diff --git a/docs/src/content/docs/reference/scripts/container.md b/docs/src/content/docs/reference/scripts/container.md index 5b6d8d4453..d8514ecb30 100644 --- a/docs/src/content/docs/reference/scripts/container.md +++ b/docs/src/content/docs/reference/scripts/container.md @@ -1,9 +1,19 @@ --- title: Containers -description: Learn how to use containers for secure and isolated execution of untrusted code with Docker in software development. +description: Learn how to use containers for secure and isolated execution of + untrusted code with Docker in software development. keywords: Docker, Containers, Software Development, Code Isolation, Execution Environment sidebar: - order: 20 + order: 20 +hero: + image: + alt: A small, pixel-style image shows a geometric box with a gear and code + brackets inside, representing a software package. A tiny shield stands + beside the box to signal security. Clean lines and shapes suggest network + connections and ports, using five corporate colors, arranged simply and + without any text or background. + file: ./container.png + --- Containers, like [Docker](https://www.docker.com/), are a way to package software and its dependencies into a standardized unit for software development. Containers are lightweight, standalone, and executable software packages that include everything needed to run an application: code, runtime, system tools, system libraries, and settings. diff --git a/docs/src/content/docs/reference/scripts/container.png b/docs/src/content/docs/reference/scripts/container.png new file mode 100644 index 0000000000..f13e22379c Binary files /dev/null and b/docs/src/content/docs/reference/scripts/container.png differ diff --git a/docs/src/content/docs/reference/scripts/content-safety.mdx b/docs/src/content/docs/reference/scripts/content-safety.mdx index cd1f8883bb..51430205ed 100644 --- a/docs/src/content/docs/reference/scripts/content-safety.mdx +++ b/docs/src/content/docs/reference/scripts/content-safety.mdx @@ -11,6 +11,16 @@ keywords: - harmful content detection - prompt injection - azure ai +hero: + image: + alt: This image shows a minimalistic 8-bit-style digital shield in the middle, + with five bold colored geometric icons arranged around it on a plain white + background. The icons are a padlock (symbolizing content protection), a + key (security), a warning triangle (security alerts), a file with a + checkmark (file validation), and a cloud (cloud authentication). There are + no people, text, shadows, or gradient effects. The design is flat, using + only five strong corporate colors, sized at 128 by 128 pixels. + file: ./content-safety.png --- diff --git a/docs/src/content/docs/reference/scripts/content-safety.png b/docs/src/content/docs/reference/scripts/content-safety.png new file mode 100644 index 0000000000..184f9bfe14 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/content-safety.png differ diff --git a/docs/src/content/docs/reference/scripts/context.md b/docs/src/content/docs/reference/scripts/context.md index 86b81e40d8..3af8dfb148 100644 --- a/docs/src/content/docs/reference/scripts/context.md +++ b/docs/src/content/docs/reference/scripts/context.md @@ -1,9 +1,23 @@ --- title: Context (env+def) sidebar: - order: 3 -description: Detailed documentation on the script execution context and environment variables in GenAIScript. + order: 3 +description: Detailed documentation on the script execution context and + environment variables in GenAIScript. keywords: script execution, env object, GenAIScript context, def function, env files +hero: + image: + alt: A simplified 2D digital illustration displays a plain folder with several + file icons above it, each symbolizing a different file type—PDF, Markdown, + Python, and CSV—distinguished by subtle color differences. The files float + in a curved arc above the folder. Shapes like divided rectangles and + arrows suggest data comparison or file differences. A small cogwheel icon + represents automation. The scene uses only five solid colors, with sharp + boundaries and very minimal detail. All items are spaced apart on a blank, + transparent background, with no text, people, shading, or + three-dimensional effects. + file: ./context.png + --- Information about the context of script execution is available in the `env` global object. diff --git a/docs/src/content/docs/reference/scripts/context.png b/docs/src/content/docs/reference/scripts/context.png new file mode 100644 index 0000000000..2eb56587bb Binary files /dev/null and b/docs/src/content/docs/reference/scripts/context.png differ diff --git a/docs/src/content/docs/reference/scripts/csv.md b/docs/src/content/docs/reference/scripts/csv.md index 73f7481671..6f8d41b59c 100644 --- a/docs/src/content/docs/reference/scripts/csv.md +++ b/docs/src/content/docs/reference/scripts/csv.md @@ -3,9 +3,18 @@ title: CSV description: Learn how to parse and stringify CSV data using the CSV class in scripting. keywords: CSV parsing, CSV stringifying, CSV data, CSV manipulation, CSV utility sidebar: - order: 17 + order: 17 genaiscript: - files: src/samples/penguins.csv + files: src/samples/penguins.csv +hero: + image: + alt: A simplified 8-bit style illustration shows a CSV file icon with a + checkmark, a grid pattern representing spreadsheet rows and columns, and a + small gear to indicate data parsing tools. The design uses only five solid + colors, has no human figures, text, shadows, gradients, or background, and + appears completely flat and two-dimensional. + file: ./csv.png + --- Parsing and stringifying of Comma Separated Values (CSV) data. diff --git a/docs/src/content/docs/reference/scripts/csv.png b/docs/src/content/docs/reference/scripts/csv.png new file mode 100644 index 0000000000..fa01dd6eb0 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/csv.png differ diff --git a/docs/src/content/docs/reference/scripts/custom-output.md b/docs/src/content/docs/reference/scripts/custom-output.md index dffafd693e..1f6f1c3365 100644 --- a/docs/src/content/docs/reference/scripts/custom-output.md +++ b/docs/src/content/docs/reference/scripts/custom-output.md @@ -1,9 +1,22 @@ --- title: Custom Output -description: Learn how to use the defOutputProcessor function for custom file processing in script generation. -keywords: custom output, defOutputProcessor, file processing, script generation, post processing +description: Learn how to use the defOutputProcessor function for custom file + processing in script generation. +keywords: custom output, defOutputProcessor, file processing, script generation, + post processing sidebar: - order: 12 + order: 12 +hero: + image: + alt: A minimalistic 8-bit style image depicts a stylized computer file with a + glowing gear symbol and an arrow, suggesting file processing or + modification. Nearby, a trash can has small colored documents hovering + above it, representing files being cleaned or deleted. The image uses five + flat colors, geometric forms, and has no background, text, people, + shadows, or gradients, maintaining a clean, corporate-friendly look in a + 128x128 pixel format. + file: ./custom-output.png + --- The `defOutputProcessor` function registers a callback to perform custom processing of the LLM output at the end of the generation process. This function allows the creation of new files or modification of existing ones. diff --git a/docs/src/content/docs/reference/scripts/custom-output.png b/docs/src/content/docs/reference/scripts/custom-output.png new file mode 100644 index 0000000000..9d9b2bfdfb Binary files /dev/null and b/docs/src/content/docs/reference/scripts/custom-output.png differ diff --git a/docs/src/content/docs/reference/scripts/diagrams.md b/docs/src/content/docs/reference/scripts/diagrams.md index 2b8c17f2f7..3d455837bd 100644 --- a/docs/src/content/docs/reference/scripts/diagrams.md +++ b/docs/src/content/docs/reference/scripts/diagrams.md @@ -2,8 +2,18 @@ title: Diagrams sidebar: order: 20 -description: Create diagrams and charts within markdown using GenAIScript and the mermaid extension for visual representation of data and processes. +description: Create diagrams and charts within markdown using GenAIScript and + the mermaid extension for visual representation of data and processes. keywords: diagrams, charts, mermaid, GenAIScript, data visualization +hero: + image: + alt: A flat, minimalistic 8-bit illustration showing two parallel colored lines, + each symbolizing a separate branch, that join together into one line, + representing a merge in version control. The design is geometric, strictly + simple, sized 128x128 pixels, with no background, text, people, shading, + or 3D effects, and uses only five distinct corporate colors. + file: ./diagrams.png + --- It is often useful to request an LLM to generate a diagram. Fortunately, diff --git a/docs/src/content/docs/reference/scripts/diagrams.png b/docs/src/content/docs/reference/scripts/diagrams.png new file mode 100644 index 0000000000..fcf5884247 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/diagrams.png differ diff --git a/docs/src/content/docs/reference/scripts/diff.md b/docs/src/content/docs/reference/scripts/diff.md index 9013afd7c6..ccf8dfe4c6 100644 --- a/docs/src/content/docs/reference/scripts/diff.md +++ b/docs/src/content/docs/reference/scripts/diff.md @@ -4,6 +4,15 @@ description: Learn how to create and interpret file diffs within GenAIScript. sidebar: order: 15 keywords: diff, file comparisons, script execution, concise output, GenAIScript +hero: + image: + alt: "A flat, simple 8-bit icon shows two rectangles side by side, each + resembling a sheet of paper. Colorful lines highlight differences: some + lines are red for deleted content, green for added content, and gray for + unchanged content. The image uses only five colors, has no text, people, + background, shadows, or 3D effects, and measures 128 by 128 pixels." + file: ./diff.png + --- # Diff diff --git a/docs/src/content/docs/reference/scripts/diff.png b/docs/src/content/docs/reference/scripts/diff.png new file mode 100644 index 0000000000..2d3dd56857 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/diff.png differ diff --git a/docs/src/content/docs/reference/scripts/docx.md b/docs/src/content/docs/reference/scripts/docx.md index bbb90cfbb4..7e39a4accb 100644 --- a/docs/src/content/docs/reference/scripts/docx.md +++ b/docs/src/content/docs/reference/scripts/docx.md @@ -1,9 +1,21 @@ --- title: DOCX -description: Learn how to parse and extract text from DOCX files for text analysis and processing. -keywords: DOCX parsing, text extraction, document conversion, file processing, text analysis +description: Learn how to parse and extract text from DOCX files for text + analysis and processing. +keywords: DOCX parsing, text extraction, document conversion, file processing, + text analysis sidebar: - order: 9 + order: 9 +hero: + image: + alt: A minimalistic 8-bit illustration shows a geometric document file with the + recognizable DOCX symbol alongside a stylized gear, symbolizing document + parsing or processing. The file is visually transforming into clean, + abstract lines of text. The design uses five corporate colors, is flat and + 2D, with no background or gradients, and measures 128x128 pixels. There + are no people or visible written text. + file: ./docx.png + --- The `def` function will automatically parse DOCX files and extract text from them: diff --git a/docs/src/content/docs/reference/scripts/docx.png b/docs/src/content/docs/reference/scripts/docx.png new file mode 100644 index 0000000000..ed13df82de Binary files /dev/null and b/docs/src/content/docs/reference/scripts/docx.png differ diff --git a/docs/src/content/docs/reference/scripts/fence-formats.md b/docs/src/content/docs/reference/scripts/fence-formats.md index 11b7c954a6..a39c44d991 100644 --- a/docs/src/content/docs/reference/scripts/fence-formats.md +++ b/docs/src/content/docs/reference/scripts/fence-formats.md @@ -1,10 +1,21 @@ --- title: Fence Formats sidebar: - order: 90 + order: 90 description: Explore various fence formats supported by GenAIScript for optimal - LLM input text formatting. + LLM input text formatting. keywords: fence format, LLM input, markdown, xml, GenAIScript +hero: + image: + alt: 'An 8-bit style icon shows three overlapping geometric panels: one features + angle brackets symbolizing XML, another displays a triple backtick and + smiley for Markdown, and the last is a plain rectangle with a smiley for + "none." Each panel is a different color, outlined simply, and there are no + gradients or shadows. The composition is flat, balanced, and uses only + five distinct corporate colors on a transparent or plain background at + 128x128 pixels.' + file: ./fence-formats.png + --- GenAIScript supports various types of "fence" formats when rendering [def](/genaiscript/reference/scripts/context) function, since LLMs may behave differently depending on the format of the input text. diff --git a/docs/src/content/docs/reference/scripts/fence-formats.png b/docs/src/content/docs/reference/scripts/fence-formats.png new file mode 100644 index 0000000000..0ae528bd01 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/fence-formats.png differ diff --git a/docs/src/content/docs/reference/scripts/fetch.md b/docs/src/content/docs/reference/scripts/fetch.md index 9507279e3c..ee810ad86e 100644 --- a/docs/src/content/docs/reference/scripts/fetch.md +++ b/docs/src/content/docs/reference/scripts/fetch.md @@ -1,9 +1,21 @@ --- title: Fetch sidebar: - order: 14 -description: Learn how to use fetch and fetchText in scripts to make HTTP requests and handle text responses. + order: 14 +description: Learn how to use fetch and fetchText in scripts to make HTTP + requests and handle text responses. keywords: fetch API, fetchText, HTTP requests, scripts, API key +hero: + image: + alt: A small, flat 2D image in 8-bit style shows a computer screen displaying a + simple browser window. In the window, there are four basic icons—a + right-pointing arrow, a cloud symbolizing the internet, a file icon, and a + gear for settings—each connected by straight lines to illustrate a + simplified API process. The image uses only five solid corporate-style + colors and no text, people, shadows, gradients, or backgrounds. The + composition is strictly geometric and minimal at 128 by 128 pixels. + file: ./fetch.png + --- The JavaScript `fetch` API is available; but we also provide a helper diff --git a/docs/src/content/docs/reference/scripts/fetch.png b/docs/src/content/docs/reference/scripts/fetch.png new file mode 100644 index 0000000000..92277516f9 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/fetch.png differ diff --git a/docs/src/content/docs/reference/scripts/file-merge.md b/docs/src/content/docs/reference/scripts/file-merge.md index 48906a2284..d93165d7c8 100644 --- a/docs/src/content/docs/reference/scripts/file-merge.md +++ b/docs/src/content/docs/reference/scripts/file-merge.md @@ -1,9 +1,20 @@ --- title: File Merge -description: Customize file merging in scripts with defFileMerge function to handle different file formats and merging strategies. -keywords: file merging, custom merge, defFileMerge, script customization, content appending +description: Customize file merging in scripts with defFileMerge function to + handle different file formats and merging strategies. +keywords: file merging, custom merge, defFileMerge, script customization, + content appending sidebar: - order: 11 + order: 11 +hero: + image: + alt: An 8-bit style icon shows a computer file with a folded corner, split into + blue on one side and green on the other, representing "before" and + "generated" document icons. An orange arrow connects both halves into one + merged file with a bold plus sign at the center. The design uses five flat + colors, simple geometric shapes, and no background. + file: ./file-merge.png + --- The `defFileMerge` function allows you to register a custom callback to override the default file merge behavior. diff --git a/docs/src/content/docs/reference/scripts/file-merge.png b/docs/src/content/docs/reference/scripts/file-merge.png new file mode 100644 index 0000000000..d57cdc3f71 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/file-merge.png differ diff --git a/docs/src/content/docs/reference/scripts/file-output.mdx b/docs/src/content/docs/reference/scripts/file-output.mdx index cc5e178201..e608fdde4d 100644 --- a/docs/src/content/docs/reference/scripts/file-output.mdx +++ b/docs/src/content/docs/reference/scripts/file-output.mdx @@ -1,9 +1,23 @@ --- title: File Output sidebar: - order: 5 -description: Learn how to declare and manage script-generated file outputs with defFileOutput function. -keywords: file output, script documentation, defFileOutput, schema validation, JSON keywords + order: 5 +description: Learn how to declare and manage script-generated file outputs with + defFileOutput function. +keywords: file output, script documentation, defFileOutput, schema validation, + JSON keywords +hero: + image: + alt: A simple digital illustration featuring a central white paper with code + lines and a pencil icon, symbolizing editing. Next to it are a folder and + a document with colored highlights, representing different changelog + entries. Surrounding these main items are small icons of a cogwheel, check + mark, and file tree, all depicted in a 5-color corporate 8-bit style. The + background is white or transparent, with no text, gradients, shadows, or + people, and all elements have a flat, geometric look. The image is 128x128 + pixels. + file: ./file-output.png + --- import { Image } from "astro:assets" diff --git a/docs/src/content/docs/reference/scripts/file-output.png b/docs/src/content/docs/reference/scripts/file-output.png new file mode 100644 index 0000000000..a7fcb2d950 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/file-output.png differ diff --git a/docs/src/content/docs/reference/scripts/files.md b/docs/src/content/docs/reference/scripts/files.md index 287f70d1f6..c69f56ee25 100644 --- a/docs/src/content/docs/reference/scripts/files.md +++ b/docs/src/content/docs/reference/scripts/files.md @@ -1,9 +1,21 @@ --- title: Files -description: Learn how to perform file system operations using the workspace object in your scripts. +description: Learn how to perform file system operations using the workspace + object in your scripts. keywords: file system, workspace object, readText, findFiles, paths sidebar: - order: 13 + order: 13 +hero: + image: + alt: A clean, flat 2D illustration in retro 8-bit style uses a five-color + corporate palette. It displays a folder icon for workspace root, + overlapping icons for PDF, DOCX, CSV, JSON, and XML files, along with + simple gear and funnel icons symbolizing filtering and searching. A shield + icon represents gitignore rules, and a pencil stands for output writing. + All icons are geometric, minimalistic, and arranged compactly on a blank + background. + file: ./files.png + --- GenAIScript provides access to the file system of workspace and to the selected files in the user interface. diff --git a/docs/src/content/docs/reference/scripts/files.png b/docs/src/content/docs/reference/scripts/files.png new file mode 100644 index 0000000000..20f668b17a Binary files /dev/null and b/docs/src/content/docs/reference/scripts/files.png differ diff --git a/docs/src/content/docs/reference/scripts/git.md b/docs/src/content/docs/reference/scripts/git.md index 80aa1989fa..c0348ed63b 100644 --- a/docs/src/content/docs/reference/scripts/git.md +++ b/docs/src/content/docs/reference/scripts/git.md @@ -2,7 +2,18 @@ title: Git description: Git utilities for repository operations sidebar: - order: 51 + order: 51 +hero: + image: + alt: An 8-bit style, two-dimensional file directory icon features branching + lines with geometric nodes to represent git branches, a small gear for + settings, and a tag icon for version tags. A directional arrow points + toward a repository box to indicate shallow cloning, while a dashed + outline marks an ignored file. The artwork uses five solid corporate + colors in a flat, minimalist design with no background or gradients, + created for a 128x128 size. + file: ./git.png + --- The `git` helper provides a thin wrapper around invoking the [git](https://git-scm.com/) executable for repository operations. diff --git a/docs/src/content/docs/reference/scripts/git.png b/docs/src/content/docs/reference/scripts/git.png new file mode 100644 index 0000000000..da618cb447 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/git.png differ diff --git a/docs/src/content/docs/reference/scripts/github.mdx b/docs/src/content/docs/reference/scripts/github.mdx index 13c7e42d95..42509b6e41 100644 --- a/docs/src/content/docs/reference/scripts/github.mdx +++ b/docs/src/content/docs/reference/scripts/github.mdx @@ -2,7 +2,19 @@ title: GitHub description: Support for querying GitHub sidebar: - order: 50 + order: 50 +hero: + image: + alt: "A geometric 8-bit style image shows the GitHub Octocat logo in the center, + with basic icons arranged around it: a speech bubble for issues and + comments, a pull request symbol, a gear for workflow, a magnifying glass + for code search, a file icon for file content, a branch for branching, a + tag for releases, and colored squares representing different repository + languages. All elements are flat, use five GitHub corporate colors, are + minimally detailed, and set in a 128x128 pixel layout without background, + shadows, gradients, text, or human figures." + file: ./github.png + --- import { PackageManagers } from "starlight-package-managers" diff --git a/docs/src/content/docs/reference/scripts/github.png b/docs/src/content/docs/reference/scripts/github.png new file mode 100644 index 0000000000..5563bd97a4 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/github.png differ diff --git a/docs/src/content/docs/reference/scripts/html.md b/docs/src/content/docs/reference/scripts/html.md index e254dea2fa..89a3502cfe 100644 --- a/docs/src/content/docs/reference/scripts/html.md +++ b/docs/src/content/docs/reference/scripts/html.md @@ -1,9 +1,21 @@ --- title: HTML -description: Learn how to use HTML parsing functions in GenAIScript for effective content manipulation and data extraction. -keywords: HTML parsing, content manipulation, data extraction, HTML to text, HTML to markdown +description: Learn how to use HTML parsing functions in GenAIScript for + effective content manipulation and data extraction. +keywords: HTML parsing, content manipulation, data extraction, HTML to text, + HTML to markdown sidebar: - order: 18 + order: 18 +hero: + image: + alt: "A small, flat 8-bit style icon divided into three vertical parts: the left + shows a plain paper with HTML angle brackets, the middle depicts a + document with horizontal text lines transitioning into lines and a hashtag + for Markdown, and the right displays a table grid blending into curly + brackets for JSON; all elements use geometric shapes and five bold + corporate colors on a plain background." + file: ./html.png + --- HTML processing enables you to parse HTML content effectively. Below you can find guidelines on using the HTML-related APIs available in GenAIScript. diff --git a/docs/src/content/docs/reference/scripts/html.png b/docs/src/content/docs/reference/scripts/html.png new file mode 100644 index 0000000000..48fd389b6e Binary files /dev/null and b/docs/src/content/docs/reference/scripts/html.png differ diff --git a/docs/src/content/docs/reference/scripts/image-generation.mdx b/docs/src/content/docs/reference/scripts/image-generation.mdx index 676fae2aff..1aadb4cd07 100644 --- a/docs/src/content/docs/reference/scripts/image-generation.mdx +++ b/docs/src/content/docs/reference/scripts/image-generation.mdx @@ -1,8 +1,20 @@ --- title: Image Generation -description: Use image generation like OpenAI DALL-E Stable Diffusion to generate images from text. +description: Use image generation like OpenAI DALL-E Stable Diffusion to + generate images from text. sidebar: - order: 41 + order: 41 +hero: + image: + alt: A small, square minimalist illustration shows a geometric computer + interface using colorful flat shapes. A paintbrush and an image icon are + arranged in a simple design, with symbolic elements alluding to + technology, large language model providers, and cloud connectivity. The + image is abstract, highly stylized, and uses only five solid colors + without any text, people, shadow, or background, highlighting a clean, + modern, corporate aesthetic. + file: ./image-generation.png + --- GenAIScript support LLM providers with [OpenAI-compatible image generation APIs](https://platform.openai.com/docs/guides/images). diff --git a/docs/src/content/docs/reference/scripts/image-generation.png b/docs/src/content/docs/reference/scripts/image-generation.png new file mode 100644 index 0000000000..bdb7fb9e51 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/image-generation.png differ diff --git a/docs/src/content/docs/reference/scripts/images.mdx b/docs/src/content/docs/reference/scripts/images.mdx index 4d90603260..35a63cc658 100644 --- a/docs/src/content/docs/reference/scripts/images.mdx +++ b/docs/src/content/docs/reference/scripts/images.mdx @@ -1,9 +1,21 @@ --- title: Images -description: Learn how to add images to prompts for AI models supporting visual inputs, including image formats and usage. +description: Learn how to add images to prompts for AI models supporting visual + inputs, including image formats and usage. keywords: images in prompts, AI model images, visual inputs, image formats, OpenAI Vision sidebar: - order: 10 + order: 10 +hero: + image: + alt: "A minimalist 8-bit style image shows five bold, geometric icons: a square + with marked corners for cropping, a circle representing a greyscale + filter, a curved arrow for rotation, a handle for scaling, and a flip + symbol. The elements are arranged together in a flat, corporate design + using only five solid colors and clean lines. There are no backgrounds, + people, text, shadows, gradients, or 3D effects, and the shapes are simple + within a small 128 by 128 pixel space." + file: ./images.png + --- import { YouTube } from "astro-embed" diff --git a/docs/src/content/docs/reference/scripts/images.png b/docs/src/content/docs/reference/scripts/images.png new file mode 100644 index 0000000000..1479258025 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/images.png differ diff --git a/docs/src/content/docs/reference/scripts/import-template.md b/docs/src/content/docs/reference/scripts/import-template.md index fe259c10e8..c8f9c47a76 100644 --- a/docs/src/content/docs/reference/scripts/import-template.md +++ b/docs/src/content/docs/reference/scripts/import-template.md @@ -1,11 +1,22 @@ --- title: Import Template sidebar: - order: 50 + order: 50 description: Learn how to import prompt templates into GenAIScript using - `importTemplate` with support for mustache variable interpolation and file - globs. + `importTemplate` with support for mustache variable interpolation and file + globs. keywords: importTemplate, prompts, mustache, variable interpolation, file globs +hero: + image: + alt: A digital scene in classic 8-bit style shows stacked rectangles with tabs, + symbolizing documents, linked by bold arrows to a computer screen with + bracket and brace icons representing code. Small circles suggest + variables, a simple clock icon refers to time, and minimal template shapes + are present. The image uses five corporate colors on a flat, single-color + background, is highly simplified and geometric, and measures 128 by 128 + pixels. There are no people, no words, and no realistic effects. + file: ./import-template.png + --- Various LLM tools allow storing prompts in text or markdown files. diff --git a/docs/src/content/docs/reference/scripts/import-template.png b/docs/src/content/docs/reference/scripts/import-template.png new file mode 100644 index 0000000000..0716c55f63 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/import-template.png differ diff --git a/docs/src/content/docs/reference/scripts/imports.mdx b/docs/src/content/docs/reference/scripts/imports.mdx index 752237628e..f6ecb03e5c 100644 --- a/docs/src/content/docs/reference/scripts/imports.mdx +++ b/docs/src/content/docs/reference/scripts/imports.mdx @@ -1,9 +1,21 @@ --- title: Imports sidebar: - order: 20 -description: Learn how to enable module imports in GenAI scripts by converting them to .mjs format and using static or dynamic imports. + order: 20 +description: Learn how to enable module imports in GenAI scripts by converting + them to .mjs format and using static or dynamic imports. keywords: imports, modules, .mjs, GenAI scripts, JavaScript +hero: + image: + alt: A flat, minimalistic graphic shows five interconnected rectangles, each + resembling documents with visible file extension icons like .mjs, .mts, + and .json. The rectangles are linked by puzzle piece shapes, symbolizing + module imports. A simple folder icon is present among them. The + illustration uses five solid corporate colors, has no text or gradients, + and appears in a pixelated 8-bit style with a transparent background and + no people or decorative effects. The image size is small and square. + file: ./imports.png + --- import { Steps } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/scripts/imports.png b/docs/src/content/docs/reference/scripts/imports.png new file mode 100644 index 0000000000..eb1a4bea37 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/imports.png differ diff --git a/docs/src/content/docs/reference/scripts/index.mdx b/docs/src/content/docs/reference/scripts/index.mdx index 41b2bd3bb4..06f382944d 100644 --- a/docs/src/content/docs/reference/scripts/index.mdx +++ b/docs/src/content/docs/reference/scripts/index.mdx @@ -1,9 +1,23 @@ --- title: Overview sidebar: - order: 0 -description: Learn how to use and customize GenAIScript templates for efficient AI prompt expansion. -keywords: script templates, AI prompts, prompt expansion, OpenAI integration, template customization + order: 0 +description: Learn how to use and customize GenAIScript templates for efficient + AI prompt expansion. +keywords: script templates, AI prompts, prompt expansion, OpenAI integration, + template customization +hero: + image: + alt: 'A small, flat, square illustration shows a plain file folder with three + simple geometric icons rising from it: a rectangle marked ".js," another + marked ".ts," and a third icon featuring a basic gear shape. The design + uses five bold, contrasting corporate colors and is composed of only + clean, flat shapes without any background or decorative effects. There are + no people, textures, or dimensional shading. The image is limited to a + 128x128 pixel size and is designed to be immediately recognizable and + iconic.' + file: ./index.png + --- import { FileTree } from "@astrojs/starlight/components" import DirectoryLinks from '../../../../components/DirectoryLinks.astro'; diff --git a/docs/src/content/docs/reference/scripts/index.png b/docs/src/content/docs/reference/scripts/index.png new file mode 100644 index 0000000000..42462a23fe Binary files /dev/null and b/docs/src/content/docs/reference/scripts/index.png differ diff --git a/docs/src/content/docs/reference/scripts/ini.md b/docs/src/content/docs/reference/scripts/ini.md index 04d3716c79..b5dd23b896 100644 --- a/docs/src/content/docs/reference/scripts/ini.md +++ b/docs/src/content/docs/reference/scripts/ini.md @@ -1,9 +1,21 @@ --- title: INI -description: Learn how to parse and stringify INI files in GenAIScript with the INI class, including methods and usage examples. +description: Learn how to parse and stringify INI files in GenAIScript with the + INI class, including methods and usage examples. sidebar: - order: 17.1 -keywords: INI parsing, INI stringifying, INI file format, .ini manipulation, configuration files + order: 17.1 +keywords: INI parsing, INI stringifying, INI file format, .ini manipulation, + configuration files +hero: + image: + alt: "An 8-bit style icon depicts a white sheet of paper split into two parts: + the left features horizontal colored stripes resembling lines in a .ini + file, while the right displays a basic code bracket symbol. A geometric + gear and a checkmark appear at one corner, implying settings parsing and + successful validation. The design is minimal, flat, uses five corporate + colors, and has no background. Icon size is 128x128 pixels." + file: ./ini.png + --- Parsing and stringifying of `.ini` data. diff --git a/docs/src/content/docs/reference/scripts/ini.png b/docs/src/content/docs/reference/scripts/ini.png new file mode 100644 index 0000000000..c2a1480961 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/ini.png differ diff --git a/docs/src/content/docs/reference/scripts/inline-prompts.mdx b/docs/src/content/docs/reference/scripts/inline-prompts.mdx index 4c7651a3e1..6d58102bf4 100644 --- a/docs/src/content/docs/reference/scripts/inline-prompts.mdx +++ b/docs/src/content/docs/reference/scripts/inline-prompts.mdx @@ -1,9 +1,24 @@ --- title: Inline prompts sidebar: - order: 10 -description: Learn how to use inline prompts with runPrompt function for inner LLM invocations in scripting. + order: 10 +description: Learn how to use inline prompts with runPrompt function for inner + LLM invocations in scripting. keywords: inline prompts, runPrompt, LLM invocation, scripting, async calls +hero: + image: + alt: "A flat, 8-bit style digital illustration in 128x128 format, featuring a + central desktop screen made of basic geometric shapes. On the screen: + simple rectangles represent code blocks; a speech bubble, resembling a + chatbot, stands out in the center; a gear icon indicates settings; stacked + file icons represent documents. Overlaying these is a concurrency diagram + made of up to 8 interlinked dots or squares, visually capping the series. + A line motif subtly branches or loops to depict networked or concurrent + processes. The palette uses only five corporate colors, and all components + remain minimal, with no people, text, background designs, or shading + effects." + file: ./inline-prompts.png + --- import { YouTube } from "astro-embed" diff --git a/docs/src/content/docs/reference/scripts/inline-prompts.png b/docs/src/content/docs/reference/scripts/inline-prompts.png new file mode 100644 index 0000000000..309206b62c Binary files /dev/null and b/docs/src/content/docs/reference/scripts/inline-prompts.png differ diff --git a/docs/src/content/docs/reference/scripts/logging.mdx b/docs/src/content/docs/reference/scripts/logging.mdx index 342abcd48c..35d305aec8 100644 --- a/docs/src/content/docs/reference/scripts/logging.mdx +++ b/docs/src/content/docs/reference/scripts/logging.mdx @@ -2,8 +2,20 @@ title: Logging description: Logging mechanism for scripts. sidebar: - order: 20 -keywords: [logging, debug] + order: 20 +keywords: + - logging + - debug +hero: + image: + alt: A simple 8-bit-style computer monitor icon shows a bold bug in one corner + and basic geometric gears on the screen, illustrating debugging and + logging processes. Three colored dots or squares sit beside the monitor, + each with a different color to represent various logging categories. The + design is clean, minimal, and uses five corporate-style colors on a plain + background with no extra details. + file: ./logging.png + --- GenAIScript uses the [debug](https://www.npmjs.com/package/debug) library for logging. diff --git a/docs/src/content/docs/reference/scripts/logging.png b/docs/src/content/docs/reference/scripts/logging.png new file mode 100644 index 0000000000..9f4ba8ee0a Binary files /dev/null and b/docs/src/content/docs/reference/scripts/logging.png differ diff --git a/docs/src/content/docs/reference/scripts/logprobs.mdx b/docs/src/content/docs/reference/scripts/logprobs.mdx index d1b1bfc94e..159cda5494 100644 --- a/docs/src/content/docs/reference/scripts/logprobs.mdx +++ b/docs/src/content/docs/reference/scripts/logprobs.mdx @@ -2,7 +2,19 @@ title: LogProbs description: Learn how to use logprobs to diagnose the performance of your scripts sidebar: - order: 50 + order: 50 +hero: + image: + alt: A flat, minimalistic 8-bit computer screen shows a horizontal row of + colored blocks, each representing a language model token with colors + shifting from blue to red to indicate high to low probability. Next to + each main block are a few smaller differently colored blocks showing + alternate tokens with top log probability. The design uses only five + distinct colors and is simple, geometric, and corporate in style, with + sharp edges and no background or extra effects. There are no people, text, + shadows, gradients, or 3D elements. + file: ./logprobs.png + --- `logprobs` is a mode where LLMs return the probability of each token. `topLogProbs` also returns list list of alternate tokens diff --git a/docs/src/content/docs/reference/scripts/logprobs.png b/docs/src/content/docs/reference/scripts/logprobs.png new file mode 100644 index 0000000000..adaa8c4461 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/logprobs.png differ diff --git a/docs/src/content/docs/reference/scripts/mcp-server.mdx b/docs/src/content/docs/reference/scripts/mcp-server.mdx index 583f14f6aa..54622e4f5d 100644 --- a/docs/src/content/docs/reference/scripts/mcp-server.mdx +++ b/docs/src/content/docs/reference/scripts/mcp-server.mdx @@ -1,8 +1,19 @@ --- title: Model Context Protocol Server sidebar: - order: 5.10 + order: 5.1 description: Turns scripts into Model Context Protocol Tools +hero: + image: + alt: An 8-bit style icon shows two interlocking shapes—a script file with + brackets and prompt arrow on one side and a server block on the other, + connected by lines signifying protocols. Five vivid colored circles and + squares represent resource blocks and parameters between the shapes. A + cloud and gear icon suggest remote access and configurable tools. All + elements are geometric, with no background, text, or people, and use only + five bold corporate colors. + file: ./mcp-server.png + --- import { Image } from "astro:assets" diff --git a/docs/src/content/docs/reference/scripts/mcp-server.png b/docs/src/content/docs/reference/scripts/mcp-server.png new file mode 100644 index 0000000000..a50da32eef Binary files /dev/null and b/docs/src/content/docs/reference/scripts/mcp-server.png differ diff --git a/docs/src/content/docs/reference/scripts/mcp-tools.mdx b/docs/src/content/docs/reference/scripts/mcp-tools.mdx index 9fddd5f290..6703a61efa 100644 --- a/docs/src/content/docs/reference/scripts/mcp-tools.mdx +++ b/docs/src/content/docs/reference/scripts/mcp-tools.mdx @@ -11,6 +11,17 @@ keywords: - tool output validation - AI tool security - prompt injection detection +hero: + image: + alt: A small, flat 8-bit style image displays two rectangular server blocks + joined by a straight line. Around each server, small colored rectangles + symbolize different tools. A shield, padlock, and magnifying glass icon + appear next to the servers, representing security, secret detection, and + validation respectively. A circular checkmark stands for signature + validation, and a tiny folder icon denotes files. The scene uses five + distinct, corporate-looking solid colors, with a simple, geometric, + minimalistic design and no background or text. + file: ./mcp-tools.png --- diff --git a/docs/src/content/docs/reference/scripts/mcp-tools.png b/docs/src/content/docs/reference/scripts/mcp-tools.png new file mode 100644 index 0000000000..67fd0faf5f Binary files /dev/null and b/docs/src/content/docs/reference/scripts/mcp-tools.png differ diff --git a/docs/src/content/docs/reference/scripts/md.md b/docs/src/content/docs/reference/scripts/md.md index 3379ae54a1..f8eb7a7c92 100644 --- a/docs/src/content/docs/reference/scripts/md.md +++ b/docs/src/content/docs/reference/scripts/md.md @@ -8,7 +8,17 @@ keywords: - frontmatter - parsing - documentation -description: Enhance your markdown capabilities with MD class helpers for parsing and managing frontmatter efficiently. +description: Enhance your markdown capabilities with MD class helpers for + parsing and managing frontmatter efficiently. +hero: + image: + alt: "An 8-bit icon with two rectangles: the top one has three colored + horizontal lines representing YAML frontmatter, the bottom features a + large stylized “M” for markdown. Abstract arrows point between them to + indicate extracting and updating data. The graphic is flat, geometric, 2D, + with five solid corporate colors, no people, text, or decorative effects, + and measures 128 by 128 pixels." + file: ./md.png --- diff --git a/docs/src/content/docs/reference/scripts/md.png b/docs/src/content/docs/reference/scripts/md.png new file mode 100644 index 0000000000..eee3c2c064 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/md.png differ diff --git a/docs/src/content/docs/reference/scripts/metadata.md b/docs/src/content/docs/reference/scripts/metadata.md index a0bbaa5302..cb6d8c4053 100644 --- a/docs/src/content/docs/reference/scripts/metadata.md +++ b/docs/src/content/docs/reference/scripts/metadata.md @@ -1,9 +1,22 @@ --- title: Metadata sidebar: - order: 2 -description: Learn how to configure script metadata to enhance functionality and user experience in GenAIScript. -keywords: script metadata, configuration, LLM parameters, customization, script management + order: 2 +description: Learn how to configure script metadata to enhance functionality and + user experience in GenAIScript. +keywords: script metadata, configuration, LLM parameters, customization, script + management +hero: + image: + alt: A small, square digital illustration in 8-bit flat style showing a + simplified computer window. Inside are separated areas formed by + rectangles and circles, each sectioned with bold, bright colors to + represent different configuration settings—model, tokens, temperature, and + group options—depicted with shapes like sliders, toggles, and labeled + blocks. The design is clean with no text, people, backgrounds, or visual + effects, emphasizing a clear, easy-to-distinguish layout. + file: ./metadata.png + --- Prompts use `script({ ... })` function call diff --git a/docs/src/content/docs/reference/scripts/metadata.png b/docs/src/content/docs/reference/scripts/metadata.png new file mode 100644 index 0000000000..1948ac9ce6 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/metadata.png differ diff --git a/docs/src/content/docs/reference/scripts/model-aliases.mdx b/docs/src/content/docs/reference/scripts/model-aliases.mdx index 686b015063..1fab8312b3 100644 --- a/docs/src/content/docs/reference/scripts/model-aliases.mdx +++ b/docs/src/content/docs/reference/scripts/model-aliases.mdx @@ -2,7 +2,20 @@ title: Model Aliases description: Give friendly names to models sidebar: - order: 60 + order: 60 +hero: + image: + alt: A simple, flat illustration features several computer screens and app + windows, each displaying distinct colored squares that signify model + aliases. These are linked by arrows to various rectangles, indicating + different AI models. The layout also includes a gear icon for + configuration, a file icon suggesting an environment (.env) file, and a + terminal or command line icon for CLI, all neatly arranged in a grid + pattern. The design uses five bold colors, an 8-bit, shadow-free style, + small dimensions, iconic appearance, no text or human figures, and a plain + setting. + file: ./model-aliases.png + --- You can define **model aliases** in your project to give friendly names to models and abstract away from a particular model version/tag. diff --git a/docs/src/content/docs/reference/scripts/model-aliases.png b/docs/src/content/docs/reference/scripts/model-aliases.png new file mode 100644 index 0000000000..1a6769e852 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/model-aliases.png differ diff --git a/docs/src/content/docs/reference/scripts/notebook.mdx b/docs/src/content/docs/reference/scripts/notebook.mdx index c834c775c9..f0441ae328 100644 --- a/docs/src/content/docs/reference/scripts/notebook.mdx +++ b/docs/src/content/docs/reference/scripts/notebook.mdx @@ -1,13 +1,25 @@ --- title: Notebook sidebar: - order: 100 + order: 100 description: Explore the features of the Markdown Notebook for authoring - documentation with script snippets and inline results. -keywords: Markdown Notebook, documentation authoring, script snippets, inline - results + documentation with script snippets and inline results. +keywords: Markdown Notebook, documentation authoring, script snippets, inline results genaiscript: - files: src/samples/markdown.md + files: src/samples/markdown.md +hero: + image: + alt: The image is a small, flat, and simple digital illustration. At the center, + there is an open notebook displaying basic code snippets and a vertical + line of chat bubbles. Beside it lies a sheet of paper featuring a large + hash symbol and thick lines, referencing Markdown formatting. Above them, + three minimalist emoji-like symbols—a seedling, a sunflower, and a + sun—appear in a row. The color palette is limited to five solid colors, + and the background is a single, plain color. There are no people, text, + shadows, gradients, or realistic details. The overall style is geometric + and 8-bit. + file: ./notebook.png + --- import { Steps } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/scripts/notebook.png b/docs/src/content/docs/reference/scripts/notebook.png new file mode 100644 index 0000000000..d508ccf0bb Binary files /dev/null and b/docs/src/content/docs/reference/scripts/notebook.png differ diff --git a/docs/src/content/docs/reference/scripts/output-builder.mdx b/docs/src/content/docs/reference/scripts/output-builder.mdx index ebf098fd11..853eb934f1 100644 --- a/docs/src/content/docs/reference/scripts/output-builder.mdx +++ b/docs/src/content/docs/reference/scripts/output-builder.mdx @@ -2,7 +2,17 @@ title: Output Builder description: Learn how to build a markdown output for your script execution sidebar: - order: 15 + order: 15 +hero: + image: + alt: A simple 8-bit style icon features various geometric shapes including + layered rectangles and squares depicting organized sections. Elements like + a heading bar, a code block, a grid resembling a table, and a small + warning triangle are grouped to represent structured data output. The + design uses five corporate colors, is flat without shading, contains no + people or text, and is set on a transparent 128 by 128 pixel background. + file: ./output-builder.png + --- The `env.output` object is used to build a markdown output for your script execution. It provides methods to add text, images, tables, and other elements to the output. diff --git a/docs/src/content/docs/reference/scripts/output-builder.png b/docs/src/content/docs/reference/scripts/output-builder.png new file mode 100644 index 0000000000..fc9a02e787 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/output-builder.png differ diff --git a/docs/src/content/docs/reference/scripts/parameters.mdx b/docs/src/content/docs/reference/scripts/parameters.mdx index bc2a943cc2..0d6efd9c72 100644 --- a/docs/src/content/docs/reference/scripts/parameters.mdx +++ b/docs/src/content/docs/reference/scripts/parameters.mdx @@ -2,7 +2,20 @@ title: Parameters Schema description: Parameters schema are used to define signatures of scripts, tools. sidebar: - order: 50 + order: 50 +hero: + image: + alt: 'A flat 8-bit geometric illustration displays a simple form panel with + three outlined fields: one for city (outlined in one color with a blue "A" + icon for text), one for year (differently colored outline with a yellow + "123" icon for numbers), and one checkbox field (another unique color + outline with a green square for boolean input). Above the panel sits a + blue gear, signifying schema transformation. To the side, a dropdown icon + suggests options and a small folder shows ".md .txt" file support. The + image uses no more than five colors, features no text, shadow, or depth, + and appears strictly flat against a white background.' + file: ./parameters.png + --- import { YouTube } from "astro-embed" diff --git a/docs/src/content/docs/reference/scripts/parameters.png b/docs/src/content/docs/reference/scripts/parameters.png new file mode 100644 index 0000000000..ffe8b858d1 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/parameters.png differ diff --git a/docs/src/content/docs/reference/scripts/parsers.md b/docs/src/content/docs/reference/scripts/parsers.md index b16bd43a21..68afc9ab1b 100644 --- a/docs/src/content/docs/reference/scripts/parsers.md +++ b/docs/src/content/docs/reference/scripts/parsers.md @@ -1,9 +1,22 @@ --- title: Parsers sidebar: - order: 12 -description: Comprehensive guide on various data format parsers including JSON5, YAML, TOML, CSV, PDF, DOCX, and token estimation for LLM. + order: 12 +description: Comprehensive guide on various data format parsers including JSON5, + YAML, TOML, CSV, PDF, DOCX, and token estimation for LLM. keywords: parsers, JSON5, YAML, TOML, CSV, token estimation +hero: + image: + alt: A small, square digital illustration shows flat, simplified icons + representing various file formats arranged neatly in a grid. Symbols + include a curly bracket for JSON5, flowing lines with dashes for YAML and + TOML, stacked bars for CSV/Excel, a single angle bracket for XML, a double + quotation mark for code, a pie chart with an equation symbol for math and + data, and a zipper indicating compressed ZIP files. Each symbol uses + clean, geometric shapes within a limited color palette, with no + background, shadows, text, or human figures. + file: ./parsers.png + --- The `parsers` object provides various parsers for common data formats. diff --git a/docs/src/content/docs/reference/scripts/parsers.png b/docs/src/content/docs/reference/scripts/parsers.png new file mode 100644 index 0000000000..241a45a048 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/parsers.png differ diff --git a/docs/src/content/docs/reference/scripts/pdf.md b/docs/src/content/docs/reference/scripts/pdf.md index bf987b0d63..7c04e6f83d 100644 --- a/docs/src/content/docs/reference/scripts/pdf.md +++ b/docs/src/content/docs/reference/scripts/pdf.md @@ -1,9 +1,20 @@ --- title: PDF -description: Learn how to extract text from PDF files for prompt generation using GenAIScript's PDF parsing capabilities. +description: Learn how to extract text from PDF files for prompt generation + using GenAIScript's PDF parsing capabilities. sidebar: - order: 9 + order: 9 keywords: PDF parsing, text extraction, pdf-parse, document conversion, prompt generation +hero: + image: + alt: A flat, 2D 8-bit style icon set on a plain background, featuring a + geometric PDF document symbol with a small cogwheel to signify parsing, + two overlapping page icons to illustrate page-by-page analysis, and a + simplified camera graphic indicating image extraction; the design uses + only five corporate colors and has no people, text, background elements, + shadows, gradients, reflections, or 3D effects. + file: ./pdf.png + --- The `def` function will automatically parse PDF files and extract text from them. This is useful for generating prompts from PDF files. diff --git a/docs/src/content/docs/reference/scripts/pdf.png b/docs/src/content/docs/reference/scripts/pdf.png new file mode 100644 index 0000000000..53700f537e Binary files /dev/null and b/docs/src/content/docs/reference/scripts/pdf.png differ diff --git a/docs/src/content/docs/reference/scripts/prompt-caching.mdx b/docs/src/content/docs/reference/scripts/prompt-caching.mdx index af43e6f338..cd5dd3f5c0 100644 --- a/docs/src/content/docs/reference/scripts/prompt-caching.mdx +++ b/docs/src/content/docs/reference/scripts/prompt-caching.mdx @@ -11,6 +11,18 @@ keywords: - LLM optimization - OpenAI prompt cache - Anthropic +hero: + image: + alt: The image is a simple 2D geometric illustration featuring two icon-like + servers or databases facing each other. The left server blends OpenAI and + Azure OpenAI logos into one shape, while the right server displays a basic + version of the Anthropic logo. Each server has a small hourglass or clock + icon above it. Arrows move between the servers, suggesting data transfer, + and abstract shapes surround them to symbolize swift data flow. The design + uses five flat, 8-bit style corporate colors, avoiding any people, text, + backgrounds, shadows, or gradients, and the whole scene is arranged within + a 128x128 pixel square. + file: ./prompt-caching.png --- diff --git a/docs/src/content/docs/reference/scripts/prompt-caching.png b/docs/src/content/docs/reference/scripts/prompt-caching.png new file mode 100644 index 0000000000..1245c95894 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/prompt-caching.png differ diff --git a/docs/src/content/docs/reference/scripts/prompt.md b/docs/src/content/docs/reference/scripts/prompt.md index ca549a44c8..4ca8cc2c01 100644 --- a/docs/src/content/docs/reference/scripts/prompt.md +++ b/docs/src/content/docs/reference/scripts/prompt.md @@ -8,6 +8,16 @@ keywords: tagged template, prompt expansion, dynamic prompts, JavaScript templates, GenAI scripting genaiscript: model: openai:gpt-3.5-turbo +hero: + image: + alt: An 8-bit-style flat icon features a geometric speech bubble containing code + brackets and a dollar sign, symbolizing coding or template expressions. + Around the bubble are small, simple blocks and circles representing + variables and template elements, all rendered in a clean, minimal, + five-color corporate palette on a transparent background, using only basic + geometric shapes. The image excludes people, text, shadows, gradients, or + 3D effects. + file: ./prompt.png --- diff --git a/docs/src/content/docs/reference/scripts/prompt.png b/docs/src/content/docs/reference/scripts/prompt.png new file mode 100644 index 0000000000..e458e95238 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/prompt.png differ diff --git a/docs/src/content/docs/reference/scripts/prompty.md b/docs/src/content/docs/reference/scripts/prompty.md index 9a4c21960e..8fd196f71c 100644 --- a/docs/src/content/docs/reference/scripts/prompty.md +++ b/docs/src/content/docs/reference/scripts/prompty.md @@ -1,11 +1,20 @@ --- title: Prompty sidebar: - order: 51 -description: - Learn about the .prompty file format for parameterized prompts and its - integration with GenAIScript for AI scripting. + order: 51 +description: Learn about the .prompty file format for parameterized prompts and + its integration with GenAIScript for AI scripting. keywords: prompty, scripts, AI, parameterized prompts, automation +hero: + image: + alt: A small, simple 8-bit-style illustration of a computer monitor with a + markdown file icon on its screen, surrounded by geometric shapes + symbolizing parameter fields, a settings gear, and chat bubbles for an AI + assistant, all in five flat corporate colors, arranged in a clean, + minimalistic layout without any background or realistic details. No + people, text, or shading appear in the image. + file: ./prompty.png + --- GenAIScript supports running [.prompty](https://prompty.ai/) files as scripts (with some limitations) or importing them in a script. diff --git a/docs/src/content/docs/reference/scripts/prompty.png b/docs/src/content/docs/reference/scripts/prompty.png new file mode 100644 index 0000000000..b9b7d9e192 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/prompty.png differ diff --git a/docs/src/content/docs/reference/scripts/pyodide.mdx b/docs/src/content/docs/reference/scripts/pyodide.mdx index c8045d036f..511774714c 100644 --- a/docs/src/content/docs/reference/scripts/pyodide.mdx +++ b/docs/src/content/docs/reference/scripts/pyodide.mdx @@ -2,7 +2,17 @@ title: Pyodide description: Run Python code in the JavaScript environment using Pyodide. sidebar: - order: 60 + order: 60 +hero: + image: + alt: A clean 2D 8-bit style graphic featuring a beige python snake curled around + flat geometric icons of a browser window and a folder, with circuit board + lines representing WebAssembly and a blue gear indicating Python code + execution. The design uses five corporate colors, has no background or + text, appears sleek and iconic, and is set at small square dimensions with + clear, sharp lines. + file: ./pyodide.png + --- [Pyodide](https://pyodide.org/) is a distribution of Python for Node.js (and the browser). diff --git a/docs/src/content/docs/reference/scripts/pyodide.png b/docs/src/content/docs/reference/scripts/pyodide.png new file mode 100644 index 0000000000..8a02a6eb69 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/pyodide.png differ diff --git a/docs/src/content/docs/reference/scripts/reasoning-models.mdx b/docs/src/content/docs/reference/scripts/reasoning-models.mdx index b248f572c4..c47824880c 100644 --- a/docs/src/content/docs/reference/scripts/reasoning-models.mdx +++ b/docs/src/content/docs/reference/scripts/reasoning-models.mdx @@ -2,7 +2,18 @@ title: Reasoning Models description: Specific information about OpenAI reasoning models. sidebar: - order: 100 + order: 100 +hero: + image: + alt: A clean 2D grid displays stylized, interconnected brain icons as colorful + circuit-like dots and lines. Distinct small shapes represent different AI + models, radiating around a central, brightly colored brain symbolizing + reasoning, with arrows linking models to show selection and varying + effort. The image uses five bold, flat colors on a white background, with + no gradients, people, or text. The image is simple and compact, sized at + 128x128 pixels. + file: ./reasoning-models.png + --- The OpenAI reasoning models, the `o1, o3` models, DeepSeek R1 or Anthropic Sonet 3.7, are models that are optimized for reasoning tasks. diff --git a/docs/src/content/docs/reference/scripts/reasoning-models.png b/docs/src/content/docs/reference/scripts/reasoning-models.png new file mode 100644 index 0000000000..19a2a3ac6f Binary files /dev/null and b/docs/src/content/docs/reference/scripts/reasoning-models.png differ diff --git a/docs/src/content/docs/reference/scripts/redteam.mdx b/docs/src/content/docs/reference/scripts/redteam.mdx index 59878cce69..a1b67b117e 100644 --- a/docs/src/content/docs/reference/scripts/redteam.mdx +++ b/docs/src/content/docs/reference/scripts/redteam.mdx @@ -11,6 +11,15 @@ keywords: - PromptFoo - LLM vulnerabilities - adversarial inputs +hero: + image: + alt: "An 8-bit style icon features a computer with a split shield in front; one + half of the shield looks normal, the other appears pixelated and glitched. + Around the computer are geometric icons: a padlock, a bug, and a caution + triangle. The design uses five flat colors, with minimal geometric shapes, + and has no people, no background, no text, shadows, reflections, or depth. + The icon is 128 by 128 pixels and has a clean, corporate feel." + file: ./redteam.png --- diff --git a/docs/src/content/docs/reference/scripts/redteam.png b/docs/src/content/docs/reference/scripts/redteam.png new file mode 100644 index 0000000000..2acd21f3f1 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/redteam.png differ diff --git a/docs/src/content/docs/reference/scripts/response-priming.md b/docs/src/content/docs/reference/scripts/response-priming.md index 7094afcc50..929ed295b7 100644 --- a/docs/src/content/docs/reference/scripts/response-priming.md +++ b/docs/src/content/docs/reference/scripts/response-priming.md @@ -1,13 +1,21 @@ --- title: Response Priming sidebar: - order: 100 + order: 100 description: Learn how to prime LLM responses with specific syntax or format - using the writeText function in scripts. + using the writeText function in scripts. keywords: response priming, LLM syntax, script formatting, writeText function, - assistant message + assistant message genaiscript: - model: openai:gpt-3.5-turbo + model: openai:gpt-3.5-turbo +hero: + image: + alt: Five sharp-edged, solid-colored squares—red, blue, green, yellow, and + purple—are evenly lined up in a row on a plain field, designed in minimal, + flat 8-bit style with no background, text, people, gradients, or shadows, + and sized at 128 by 128 pixels. + file: ./response-priming.png + --- It is possible to provide the start of the LLM response (`assistant` message) in the script. diff --git a/docs/src/content/docs/reference/scripts/response-priming.png b/docs/src/content/docs/reference/scripts/response-priming.png new file mode 100644 index 0000000000..0449b5ba84 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/response-priming.png differ diff --git a/docs/src/content/docs/reference/scripts/retrieval.mdx b/docs/src/content/docs/reference/scripts/retrieval.mdx index be83d962c0..c14e3102f7 100644 --- a/docs/src/content/docs/reference/scripts/retrieval.mdx +++ b/docs/src/content/docs/reference/scripts/retrieval.mdx @@ -1,9 +1,22 @@ --- title: Retrieval sidebar: - order: 10 -description: Learn how to use GenAIScript's retrieval utilities for content search and prompt augmentation with RAG techniques. -keywords: RAG, content retrieval, search augmentation, indexing, web search, Azure AI Search + order: 10 +description: Learn how to use GenAIScript's retrieval utilities for content + search and prompt augmentation with RAG techniques. +keywords: RAG, content retrieval, search augmentation, indexing, web search, + Azure AI Search +hero: + image: + alt: "A minimalist 8-bit illustration features three evenly spaced icons: the + first is a grid made of colored squares representing vector search; the + second is a magnifying glass above horizontal rectangles symbolizing fuzzy + search; the third is a globe next to a browser window indicating web + search. Only five flat colors are used, set against a plain white + background with clear separation and symmetry, all in a clean 128x128 + layout." + file: ./retrieval.png + --- import { YouTube } from "astro-embed" diff --git a/docs/src/content/docs/reference/scripts/retrieval.png b/docs/src/content/docs/reference/scripts/retrieval.png new file mode 100644 index 0000000000..4226b39228 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/retrieval.png differ diff --git a/docs/src/content/docs/reference/scripts/runtime.mdx b/docs/src/content/docs/reference/scripts/runtime.mdx index f7b80da26b..e600ee02c0 100644 --- a/docs/src/content/docs/reference/scripts/runtime.mdx +++ b/docs/src/content/docs/reference/scripts/runtime.mdx @@ -2,8 +2,18 @@ title: Runtime description: GenAIScript runtime files sidebar: - order: 80 + order: 80 keywords: runtime, GenAIScript, JavaScript, TypeScript +hero: + image: + alt: A simple, flat 2D illustration depicts an open package box with basic + digital script symbols, small code blocks, and algorithm icons rising from + it. Stylized arrows represent data flow around the box. The art uses five + solid corporate colors in an 8-bit, geometric, pixelated style. The image + is 128x128 pixels, transparent background, no text, no people, and no + shading. + file: ./runtime.png + --- import { PackageManagers } from "starlight-package-managers" diff --git a/docs/src/content/docs/reference/scripts/runtime.png b/docs/src/content/docs/reference/scripts/runtime.png new file mode 100644 index 0000000000..5e81fe9cc5 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/runtime.png differ diff --git a/docs/src/content/docs/reference/scripts/schemas.mdx b/docs/src/content/docs/reference/scripts/schemas.mdx index af77e1ff6b..fa0c9e1bf9 100644 --- a/docs/src/content/docs/reference/scripts/schemas.mdx +++ b/docs/src/content/docs/reference/scripts/schemas.mdx @@ -1,11 +1,20 @@ --- title: Data Schemas sidebar: - order: 6 + order: 6 description: Learn how to define and use data schemas for structured output in - JSON/YAML with LLM, including validation and repair techniques. + JSON/YAML with LLM, including validation and repair techniques. keywords: data schemas, JSON schema, YAML validation, LLM structured output, - schema repair + schema repair +hero: + image: + alt: A simple 8-bit styled icon features three small colored squares, each + depicting a data type symbol (number, string, and web link), linked by + thin lines to a larger, rounded central square symbolizing a schema. The + image uses five flat corporate colors, omits text and human figures, and + is set on a transparent background. + file: ./schemas.png + --- import { Card } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/scripts/schemas.png b/docs/src/content/docs/reference/scripts/schemas.png new file mode 100644 index 0000000000..ddafb8f501 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/schemas.png differ diff --git a/docs/src/content/docs/reference/scripts/secret-scanning.mdx b/docs/src/content/docs/reference/scripts/secret-scanning.mdx index 36a687a4f5..e50ca03263 100644 --- a/docs/src/content/docs/reference/scripts/secret-scanning.mdx +++ b/docs/src/content/docs/reference/scripts/secret-scanning.mdx @@ -11,6 +11,16 @@ keywords: - pattern detection - regex secrets - secure code +hero: + image: + alt: A simple 8-bit style illustration features a desktop computer displaying a + code window with lines blacked out to represent redacted information, + accompanied by a shield icon marked with an asterisk to indicate security + or secret protection, and a gear icon symbolizing customizable settings. + The design uses five solid geometric colors, with no people, text, + background, shadows, gradients, or three-dimensional effects, fitting a + corporate look at a small 128x128 pixel size. + file: ./secret-scanning.png --- diff --git a/docs/src/content/docs/reference/scripts/secret-scanning.png b/docs/src/content/docs/reference/scripts/secret-scanning.png new file mode 100644 index 0000000000..93130e2c6f Binary files /dev/null and b/docs/src/content/docs/reference/scripts/secret-scanning.png differ diff --git a/docs/src/content/docs/reference/scripts/secrets.md b/docs/src/content/docs/reference/scripts/secrets.md index 9a9e4f9c50..a263828f8b 100644 --- a/docs/src/content/docs/reference/scripts/secrets.md +++ b/docs/src/content/docs/reference/scripts/secrets.md @@ -1,9 +1,21 @@ --- title: Secrets -description: Learn how to securely access and manage environment secrets in your scripts with env.secrets object. -keywords: secrets management, environment variables, secure access, .env file, script configuration +description: Learn how to securely access and manage environment secrets in your + scripts with env.secrets object. +keywords: secrets management, environment variables, secure access, .env file, + script configuration sidebar: - order: 16 + order: 16 +hero: + image: + alt: A flat, 2D computer screen icon in a geometric 8-bit style shows a minimal + rectangular file, meant to represent an environment (.env) file, with a + padlock symbol in front of it to suggest security. Beside this, there are + clear, overlapping code brackets and a key symbol placed within a circle. + The design uses only five solid corporate colors, is clean and iconic, and + fits within a small square with no text, background, people, or shadows. + file: ./secrets.png + --- The `env.secrets` object is used to access secrets from the environment. The secrets are typically stored in the `.env` file in the root of the project (or in the `process.env` for the CLI). diff --git a/docs/src/content/docs/reference/scripts/secrets.png b/docs/src/content/docs/reference/scripts/secrets.png new file mode 100644 index 0000000000..6ef021349e Binary files /dev/null and b/docs/src/content/docs/reference/scripts/secrets.png differ diff --git a/docs/src/content/docs/reference/scripts/structured-output.mdx b/docs/src/content/docs/reference/scripts/structured-output.mdx index 24a8c49993..e3d8f122ea 100644 --- a/docs/src/content/docs/reference/scripts/structured-output.mdx +++ b/docs/src/content/docs/reference/scripts/structured-output.mdx @@ -1,9 +1,20 @@ --- title: Structured Outputs sidebar: - order: 12.1 -description: Utilize structured output in GenAIScript to generate JSON data with schema validation for precise and reliable data structuring. + order: 12.1 +description: Utilize structured output in GenAIScript to generate JSON data with + schema validation for precise and reliable data structuring. keywords: structured output, JSON schema, GenAIScript, data validation, reliable data +hero: + image: + alt: A small, clean 2D flowchart made of flat geometric colored blocks, with + arrows linking rectangles that symbolize different data formats such as + JSON, YAML, and schema. Includes simple shapes like clipboards, + checkboxes, and code brackets, as well as a single stylized computer + window. Uses five bold corporate colors, appearing flat and minimalistic + with no background, gradients, people, or text. + file: ./structured-output.png + --- import { YouTube } from "astro-embed" diff --git a/docs/src/content/docs/reference/scripts/structured-output.png b/docs/src/content/docs/reference/scripts/structured-output.png new file mode 100644 index 0000000000..e0659e6918 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/structured-output.png differ diff --git a/docs/src/content/docs/reference/scripts/system.mdx b/docs/src/content/docs/reference/scripts/system.mdx index 3f4dbb8e1d..c8d455dbc7 100644 --- a/docs/src/content/docs/reference/scripts/system.mdx +++ b/docs/src/content/docs/reference/scripts/system.mdx @@ -1,9 +1,14 @@ --- title: System Prompts sidebar: - order: 10 + order: 10 description: Learn how to utilize system prompts to enhance script execution in GenAIScript. keywords: system prompts, script execution, genai templates, environment consistency +hero: + image: + alt: No image prompt was provided to describe. + file: ./system.png + --- System prompts are scripts that are executed and injected before the main prompt output. diff --git a/docs/src/content/docs/reference/scripts/system.png b/docs/src/content/docs/reference/scripts/system.png new file mode 100644 index 0000000000..ecd69ebdb1 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/system.png differ diff --git a/docs/src/content/docs/reference/scripts/teams.mdx b/docs/src/content/docs/reference/scripts/teams.mdx index 4365acd996..94d1543e3b 100644 --- a/docs/src/content/docs/reference/scripts/teams.mdx +++ b/docs/src/content/docs/reference/scripts/teams.mdx @@ -2,7 +2,16 @@ title: Microsoft Teams description: Learn how to use the Microsoft Teams integration in your scripts. sidebar: - order: 80 + order: 80 +hero: + image: + alt: A minimal 8-bit style illustration displays a basic computer monitor; in + front of it sits a document icon with a paperclip, suggesting file + attachment. Next to these are a small Microsoft Teams channel symbol and a + folder icon indicating SharePoint upload. The image uses five flat colors, + features no people or text, and appears on a transparent background. + file: ./teams.png + --- GenAIScript provides APIs to post a message, with file attachments, to a given diff --git a/docs/src/content/docs/reference/scripts/teams.png b/docs/src/content/docs/reference/scripts/teams.png new file mode 100644 index 0000000000..cfdbb06ed2 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/teams.png differ diff --git a/docs/src/content/docs/reference/scripts/tests.mdx b/docs/src/content/docs/reference/scripts/tests.mdx index 180e8f6b35..5cfb6463b6 100644 --- a/docs/src/content/docs/reference/scripts/tests.mdx +++ b/docs/src/content/docs/reference/scripts/tests.mdx @@ -1,9 +1,20 @@ --- title: Tests / Evals sidebar: - order: 11 -description: Learn how to execute and evaluate LLM output quality with promptfoo, a tool designed for testing language model outputs. + order: 11 +description: Learn how to execute and evaluate LLM output quality with + promptfoo, a tool designed for testing language model outputs. keywords: promptfoo, LLM testing, output quality, language model evaluation, script tests +hero: + image: + alt: A flat, colorful illustration on a white background features a clipboard + with checkmarks to represent testing, overlapping minimalist file icons + marked with code file extensions (.js, .json, .csv, .ts), a puzzle piece + as a symbol for integration, two connected neural network nodes with a + gear for LLMs and evaluation, and a shield with an exclamation mark + indicating AI vulnerabilities—all rendered in a five-color, 8-bit style. + file: ./tests.png + --- It is possible to define tests/tests for the LLM scripts, to evaluate the output quality of the LLM diff --git a/docs/src/content/docs/reference/scripts/tests.png b/docs/src/content/docs/reference/scripts/tests.png new file mode 100644 index 0000000000..cdd02e4cd3 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/tests.png differ diff --git a/docs/src/content/docs/reference/scripts/tokenizers.md b/docs/src/content/docs/reference/scripts/tokenizers.md index 9e2728eb66..83862bf922 100644 --- a/docs/src/content/docs/reference/scripts/tokenizers.md +++ b/docs/src/content/docs/reference/scripts/tokenizers.md @@ -2,7 +2,17 @@ title: Tokenizers description: Tokenizers are used to split text into tokens. sidebar: - order: 60 + order: 60 +hero: + image: + alt: An 8-bit style illustration of a geometric speech bubble made up of + distinct, colored blocks to represent separate text tokens; some small + colored rectangles detach from the main shape, symbolizing text chunking; + a basic slider icon illustrates truncation. The image is minimalistic, + flat, in five colors, sized 128x128 pixels, with no background or human + figures. + file: ./tokenizers.png + --- The `tokenizers` helper module provides a set of functions to split text into tokens. diff --git a/docs/src/content/docs/reference/scripts/tokenizers.png b/docs/src/content/docs/reference/scripts/tokenizers.png new file mode 100644 index 0000000000..85e2a4ea11 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/tokenizers.png differ diff --git a/docs/src/content/docs/reference/scripts/tools.mdx b/docs/src/content/docs/reference/scripts/tools.mdx index 670dc82c3b..774f76ef31 100644 --- a/docs/src/content/docs/reference/scripts/tools.mdx +++ b/docs/src/content/docs/reference/scripts/tools.mdx @@ -1,9 +1,18 @@ --- title: Tools -description: Learn how to define and use tools within GenAIScript to enhance answer assembly with custom logic and CLI tools. +description: Learn how to define and use tools within GenAIScript to enhance + answer assembly with custom logic and CLI tools. keywords: functions,tools, custom logic, CLI integration, scripting, automation sidebar: - order: 5 + order: 5 +hero: + image: + alt: Two brightly colored 8-bit puzzle pieces interlock; one displays a robot + head to symbolize AI, the other shows a sun, cloud, and math symbol. + Nearby are a simple gear and a browser window, all in a bold outlined, + minimal geometric style. No people or background. + file: ./tools.png + --- import { Code } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/scripts/tools.png b/docs/src/content/docs/reference/scripts/tools.png new file mode 100644 index 0000000000..4befac13f1 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/tools.png differ diff --git a/docs/src/content/docs/reference/scripts/transcription.mdx b/docs/src/content/docs/reference/scripts/transcription.mdx index 5bf166e4b7..c3ac848e3b 100644 --- a/docs/src/content/docs/reference/scripts/transcription.mdx +++ b/docs/src/content/docs/reference/scripts/transcription.mdx @@ -2,7 +2,17 @@ title: Audio Transcription description: Describe how to transcribe an audio/video file sidebar: - order: 40 + order: 40 +hero: + image: + alt: A simple 8-bit style graphic features a blocky computer monitor displaying + an audio waveform. Nearby, a video file icon transitions into an audio + file icon, indicated by an arrow between them. There is also a symbol for + SRT subtitles and a small settings gear, all created with flat geometric + shapes using five colors against a blank background. There are no people + or text in the image, and the size is 128 by 128 pixels. + file: ./transcription.png + --- GenAIScript supports transcription and translations from OpenAI like APIs. diff --git a/docs/src/content/docs/reference/scripts/transcription.png b/docs/src/content/docs/reference/scripts/transcription.png new file mode 100644 index 0000000000..d5284f9bf8 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/transcription.png differ diff --git a/docs/src/content/docs/reference/scripts/types.mdx b/docs/src/content/docs/reference/scripts/types.mdx index e978b4af43..3d5697c3c7 100644 --- a/docs/src/content/docs/reference/scripts/types.mdx +++ b/docs/src/content/docs/reference/scripts/types.mdx @@ -2,14 +2,25 @@ title: Types description: TypeScript Type Definition File sidebar: - order: 100000 + order: 100000 keywords: - - TypeScript - - Type Definition - - Types - - TypeScript Types - - Type Definitions - - TypeScript Type Definitions + - TypeScript + - Type Definition + - Types + - TypeScript Types + - Type Definitions + - TypeScript Type Definitions +hero: + image: + alt: A small, square icon features a simple geometric document outlined in one + of five corporate colors, with angled brackets and abstract interface + shapes on its surface to represent coding. The document contains dot and + dash marks to suggest programming elements, all set against a plain, + untextured background. The style is flat, minimal, and pixelated, with no + shading, shadows, gradients, or any 3D effects. No people or text appear + in the image. + file: ./types.png + --- import { Code } from "@astrojs/starlight/components" diff --git a/docs/src/content/docs/reference/scripts/types.png b/docs/src/content/docs/reference/scripts/types.png new file mode 100644 index 0000000000..331e1a0a85 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/types.png differ diff --git a/docs/src/content/docs/reference/scripts/typescript.md b/docs/src/content/docs/reference/scripts/typescript.md index d2d9009556..c5460668b9 100644 --- a/docs/src/content/docs/reference/scripts/typescript.md +++ b/docs/src/content/docs/reference/scripts/typescript.md @@ -1,9 +1,20 @@ --- title: TypeScript sidebar: - order: 15 -description: Learn how to use TypeScript for better tooling and scalability in your GenAIScript projects. + order: 15 +description: Learn how to use TypeScript for better tooling and scalability in + your GenAIScript projects. keywords: TypeScript, JavaScript, ESM, dynamic imports, type checking +hero: + image: + alt: 'A simple 8-bit style image shows a blue file icon marked ".mts" linked + with dotted lines to two other file icons: a dark gray one representing + JavaScript and a light gray one for TypeScript. All icons are arranged on + a plain white background with a geometric arrow indicating import, using + blue, gray, black, white, and yellow. The design is flat, highly + simplified, without people or text, and measures 128 by 128 pixels.' + file: ./typescript.png + --- [TypeScript](https://www.typescriptlang.org/) is a strongly typed programming language that builds on JavaScript, giving you better tooling at any scale. GenAIScript scripts can be authored in TypeScript. diff --git a/docs/src/content/docs/reference/scripts/typescript.png b/docs/src/content/docs/reference/scripts/typescript.png new file mode 100644 index 0000000000..0748b66515 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/typescript.png differ diff --git a/docs/src/content/docs/reference/scripts/user-input.mdx b/docs/src/content/docs/reference/scripts/user-input.mdx index da9ead714c..b13f25ab7b 100644 --- a/docs/src/content/docs/reference/scripts/user-input.mdx +++ b/docs/src/content/docs/reference/scripts/user-input.mdx @@ -2,7 +2,17 @@ title: User Input description: How to get user input in a script sidebar: - order: 80 + order: 80 +hero: + image: + alt: "A flat 2D digital drawing shows a stylized computer terminal interface in + a simple, 8-bit style using five colors. It includes three geometric + elements: a yes/no dialog box with check and x icons, a plain input field, + and a vertical list with one highlighted selection. The design features + clean lines and a solid color setting with no background details or human + figures, all within a 128 by 128 pixel square." + file: ./user-input.png + --- GenAIScript provides various functions to get user input in a script diff --git a/docs/src/content/docs/reference/scripts/user-input.png b/docs/src/content/docs/reference/scripts/user-input.png new file mode 100644 index 0000000000..b1786237af Binary files /dev/null and b/docs/src/content/docs/reference/scripts/user-input.png differ diff --git a/docs/src/content/docs/reference/scripts/variables.mdx b/docs/src/content/docs/reference/scripts/variables.mdx index e30ae5d416..75c9b75630 100644 --- a/docs/src/content/docs/reference/scripts/variables.mdx +++ b/docs/src/content/docs/reference/scripts/variables.mdx @@ -1,9 +1,21 @@ --- title: Variables -description: Discover how to utilize and customize script variables for dynamic scripting capabilities with env.vars. -keywords: script variables, environment variables, CLI overrides, dynamic scripting, configuration +description: Discover how to utilize and customize script variables for dynamic + scripting capabilities with env.vars. +keywords: script variables, environment variables, CLI overrides, dynamic + scripting, configuration sidebar: - order: 3.5 + order: 3.5 +hero: + image: + alt: A simple 8-bit style scene features geometric arrangements of abstract + icons representing variables—such as sliders, checkboxes, and dropdown + menus—alongside visual elements resembling code blocks and command line + input rectangles. The icons and blocks are rendered in five distinct + corporate colors, set against a plain, neutral background, without shading + or decorative effects. + file: ./variables.png + --- The `env.vars` object contains a set of variable values. You can use these variables to parameterize your script. diff --git a/docs/src/content/docs/reference/scripts/variables.png b/docs/src/content/docs/reference/scripts/variables.png new file mode 100644 index 0000000000..af30415ff3 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/variables.png differ diff --git a/docs/src/content/docs/reference/scripts/vector-search.mdx b/docs/src/content/docs/reference/scripts/vector-search.mdx index e0a86ff67c..15daef6dd0 100644 --- a/docs/src/content/docs/reference/scripts/vector-search.mdx +++ b/docs/src/content/docs/reference/scripts/vector-search.mdx @@ -1,9 +1,22 @@ --- title: Vector Search sidebar: - order: 10 -description: Learn how to use the retrieval.vectorSearch function to index files with embeddings for efficient similarity search in vector databases. + order: 10 +description: Learn how to use the retrieval.vectorSearch function to index files + with embeddings for efficient similarity search in vector databases. keywords: embeddings search, similarity search, vector database, indexing, LLM API +hero: + image: + alt: "A minimal, pixelated 8-bit image shows four main icons: a plain computer + file, a classic database cylinder, a search magnifying glass, and a + network of connected blocks implying data relationships. These simple, + geometric icons use five bold, flat colors typical of corporate design. + The objects are arranged closely together, nodding to concepts like file + storage, local and cloud databases, data chunking, and search operations. + There are no background elements, text, people, gradients, shadows, or 3D + effects, all confined to a compact 128x128 pixel square." + file: ./vector-search.png + --- import { YouTube } from "astro-embed" diff --git a/docs/src/content/docs/reference/scripts/vector-search.png b/docs/src/content/docs/reference/scripts/vector-search.png new file mode 100644 index 0000000000..ea646e9147 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/vector-search.png differ diff --git a/docs/src/content/docs/reference/scripts/videos.mdx b/docs/src/content/docs/reference/scripts/videos.mdx index aa6ba01ba7..036d387268 100644 --- a/docs/src/content/docs/reference/scripts/videos.mdx +++ b/docs/src/content/docs/reference/scripts/videos.mdx @@ -2,7 +2,17 @@ title: Videos as Inputs description: How to use the Video in scripts sidebar: - order: 10.01 + order: 10.01 +hero: + image: + alt: "A small, square, flat-design icon features simplified shapes: a film + strip, camera, and scissors grouped to indicate video cutting; a jagged + line for an audio waveform to suggest audio extraction; and a plain + rectangle representing extracted video frames. The icon uses a basic, + 8-bit, 5-color palette, all in a geometric, corporate style, with no + background, people, or text." + file: ./videos.png + --- While most LLMs do not support videos natively, they can be integrated in scripts by rendering frames diff --git a/docs/src/content/docs/reference/scripts/videos.png b/docs/src/content/docs/reference/scripts/videos.png new file mode 100644 index 0000000000..19dad105c7 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/videos.png differ diff --git a/docs/src/content/docs/reference/scripts/web-search.mdx b/docs/src/content/docs/reference/scripts/web-search.mdx index 2088d8f8ba..ee1a582f33 100644 --- a/docs/src/content/docs/reference/scripts/web-search.mdx +++ b/docs/src/content/docs/reference/scripts/web-search.mdx @@ -1,9 +1,20 @@ --- title: Web Search description: Execute web searches with the Bing API using retrieval.webSearch in scripts. -keywords: web search, Bing API, Tavily, search automation, API configuration, search function +keywords: web search, Bing API, Tavily, search automation, API configuration, + search function sidebar: - order: 15 + order: 15 +hero: + image: + alt: A minimalistic 2D digital image shows a stylized browser window with a + magnifying glass hovering over abstract web page icons. Small dots and + lines suggest APIs, with a key icon nearby indicating API keys, and two + cloud icons featuring gear symbols to represent cloud-based services. The + illustration uses a simple 8-bit, five-color palette, and bold flat lines, + all without text, people, or background features. + file: ./web-search.png + --- The `retrieval.webSearch` executes a web search using [Tavily](https://docs.tavily.com/) or the Bing Web Search. diff --git a/docs/src/content/docs/reference/scripts/web-search.png b/docs/src/content/docs/reference/scripts/web-search.png new file mode 100644 index 0000000000..d6c1c72dbe Binary files /dev/null and b/docs/src/content/docs/reference/scripts/web-search.png differ diff --git a/docs/src/content/docs/reference/scripts/xlsx.md b/docs/src/content/docs/reference/scripts/xlsx.md index 9ac2710c05..77fa1b071e 100644 --- a/docs/src/content/docs/reference/scripts/xlsx.md +++ b/docs/src/content/docs/reference/scripts/xlsx.md @@ -1,9 +1,20 @@ --- title: XLSX description: Learn how to parse and stringify Excel XLSX files with ease using our tools. -keywords: XLSX parsing, Excel file handling, spreadsheet manipulation, XLSX stringify, Excel data processing +keywords: XLSX parsing, Excel file handling, spreadsheet manipulation, XLSX + stringify, Excel data processing sidebar: - order: 17.5 + order: 17.5 +hero: + image: + alt: A simple 2D 8-bit style icon depicts a geometric spreadsheet with visible + grid cells and bold, blocky tabs. Over the spreadsheet is a thickly + outlined gear symbol, representing a parser. The design uses five distinct + corporate colors, features only flat, basic shapes, and is shown without + people or text, against a transparent background. The image is small and + square, 128 by 128 pixels, with no shadows or gradients. + file: ./xlsx.png + --- Parsing and stringifying of Excel spreadsheet files, xlsx. diff --git a/docs/src/content/docs/reference/scripts/xlsx.png b/docs/src/content/docs/reference/scripts/xlsx.png new file mode 100644 index 0000000000..14854bed85 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/xlsx.png differ diff --git a/docs/src/content/docs/reference/scripts/xml.mdx b/docs/src/content/docs/reference/scripts/xml.mdx index 33c764822b..7fa27686ff 100644 --- a/docs/src/content/docs/reference/scripts/xml.mdx +++ b/docs/src/content/docs/reference/scripts/xml.mdx @@ -11,6 +11,17 @@ keywords: - file processing - RSS feeds - data extraction +hero: + image: + alt: "An 8-bit-style geometric illustration features three main icons: a + computer file labeled with XML symbols, a basic document showing bracket + shapes, and a square marked with curly braces to represent JSON. These + icons are connected by one arrow to symbolize parsing. Nearby, a feed + symbol and another arrow lead toward a plain geometric representation of a + book, illustrating the conversion of RSS to plain text. The design uses + five flat corporate colors, simple forms, no background, and avoids extra + details, arranged within a small square format." + file: ./xml.png --- diff --git a/docs/src/content/docs/reference/scripts/xml.png b/docs/src/content/docs/reference/scripts/xml.png new file mode 100644 index 0000000000..8e65d57339 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/xml.png differ diff --git a/docs/src/content/docs/reference/scripts/yaml.md b/docs/src/content/docs/reference/scripts/yaml.md index c4a1b4b7d3..a2dbb019cb 100644 --- a/docs/src/content/docs/reference/scripts/yaml.md +++ b/docs/src/content/docs/reference/scripts/yaml.md @@ -1,9 +1,22 @@ --- title: YAML -description: Learn how to use YAML for data serialization, configuration, and parsing in LLM with defData, YAML class, and JSON schema validation. +description: Learn how to use YAML for data serialization, configuration, and + parsing in LLM with defData, YAML class, and JSON schema validation. sidebar: - order: 16 -keywords: YAML serialization, configuration files, data parsing, YAML stringify, YAML parse + order: 16 +keywords: YAML serialization, configuration files, data parsing, YAML stringify, + YAML parse +hero: + image: + alt: "Two abstract, 8-bit style icons represent data files: the first has three + horizontal lines, indicating YAML format; the second shows curly brackets + and an arrow, symbolizing a coding function. A minimalist gear stands for + parsing or validation, and simple lines connect the files, function, and + gear to suggest the process flow. The design uses five distinct corporate + colors, stays flat, minimal, and abstract, and is set at a compact 128x128 + size with no background." + file: ./yaml.png + --- [YAML](https://yaml.org/) is a human-readable data serialization format that is commonly used for configuration files and data exchange. diff --git a/docs/src/content/docs/reference/scripts/yaml.png b/docs/src/content/docs/reference/scripts/yaml.png new file mode 100644 index 0000000000..868775a375 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/yaml.png differ diff --git a/docs/src/content/docs/reference/scripts/z3.mdx b/docs/src/content/docs/reference/scripts/z3.mdx index 7fa012fabd..b122a92eec 100644 --- a/docs/src/content/docs/reference/scripts/z3.mdx +++ b/docs/src/content/docs/reference/scripts/z3.mdx @@ -1,8 +1,20 @@ --- title: Z3 -description: Z3 is a high-performance theorem prover developed at Microsoft Research. It is a built-in tool of GenAIScript. +description: Z3 is a high-performance theorem prover developed at Microsoft + Research. It is a built-in tool of GenAIScript. sidebar: - order: 200 + order: 200 +hero: + image: + alt: "A small, 8-bit style computer chip labeled as Z3 is centrally positioned, + with fine lines linking it to three simple shapes: a circle containing a + checkmark to suggest problem solving, a square featuring an inequality + sign to indicate logical constraints, and a triangle with tiny gears + inside to represent verifying programs. The image uses only blue, gray, + black, white, and green, appears flat and geometric with a professional, + minimalistic look, and has no background or human figures." + file: ./z3.png + --- [Z3](https://microsoft.github.io/z3guide/) is a high-performance theorem prover developed at Microsoft Research. It is a built-in tool of GenAIScript. Z3 is used to solve logical formulas diff --git a/docs/src/content/docs/reference/scripts/z3.png b/docs/src/content/docs/reference/scripts/z3.png new file mode 100644 index 0000000000..341246c9f8 Binary files /dev/null and b/docs/src/content/docs/reference/scripts/z3.png differ diff --git a/docs/src/content/docs/reference/security-and-trust.mdx b/docs/src/content/docs/reference/security-and-trust.mdx index da06d65a18..f68e95c98b 100644 --- a/docs/src/content/docs/reference/security-and-trust.mdx +++ b/docs/src/content/docs/reference/security-and-trust.mdx @@ -1,9 +1,20 @@ --- title: Security and Trust sidebar: - order: 99 -description: Learn about the security risks and mitigation strategies for using AI-generated scripts in development environments. + order: 99 +description: Learn about the security risks and mitigation strategies for using + AI-generated scripts in development environments. keywords: security, LLM outputs, JavaScript runtime, VSCode, code safety +hero: + image: + alt: The image shows a basic 2D 8-bit style computer monitor with a yellow + warning triangle on the screen. Around it are overlapping shapes + symbolizing code blocks, a small padlock indicating security, and a + document icon with a jagged line to suggest a risky script. The + illustration uses five flat colors, has no background, people, or text, + and is presented in a clear, iconic manner. + file: ./security-and-trust.png + --- import WarningCode from "../../../components/WarningCode.astro" diff --git a/docs/src/content/docs/reference/security-and-trust.png b/docs/src/content/docs/reference/security-and-trust.png new file mode 100644 index 0000000000..120ea4a2a1 Binary files /dev/null and b/docs/src/content/docs/reference/security-and-trust.png differ diff --git a/docs/src/content/docs/reference/transparency-note.mdx b/docs/src/content/docs/reference/transparency-note.mdx index 4cd5988ab5..5e303d873f 100644 --- a/docs/src/content/docs/reference/transparency-note.mdx +++ b/docs/src/content/docs/reference/transparency-note.mdx @@ -1,10 +1,21 @@ --- title: Transparency Note sidebar: - order: 99 -description: Learn about the GenAIScript framework, its capabilities, use cases, and best practices for responsible AI integration. + order: 99 +description: Learn about the GenAIScript framework, its capabilities, use cases, + and best practices for responsible AI integration. keywords: AI scripting, LLM integration, VS Code extension, AI automation, responsible AI lastUpdated: 2024-04-13 +hero: + image: + alt: A minimalistic 8-bit graphic featuring a stylized laptop with a VS Code + extension icon in the center, surrounded by colorful geometric file icons + representing various formats. Arrows connect these elements to a + circuit-themed AI brain symbol, all illustrated with sharp, interconnected + shapes in a palette of five corporate colors. The image includes no + people, text, gradients, or background, and is sized at 128 by 128 pixels. + file: ./transparency-note.png + --- ## The Basics of GenAIScript diff --git a/docs/src/content/docs/reference/transparency-note.png b/docs/src/content/docs/reference/transparency-note.png new file mode 100644 index 0000000000..32f5d2f341 Binary files /dev/null and b/docs/src/content/docs/reference/transparency-note.png differ diff --git a/docs/src/content/docs/reference/vscode/gistpad.png b/docs/src/content/docs/reference/vscode/gistpad.png index c0bf15eb4d..17d3a0ab63 100644 Binary files a/docs/src/content/docs/reference/vscode/gistpad.png and b/docs/src/content/docs/reference/vscode/gistpad.png differ diff --git a/docs/src/content/docs/reference/vscode/gists.mdx b/docs/src/content/docs/reference/vscode/gists.mdx index b727ba7a57..e3cc53fb7d 100644 --- a/docs/src/content/docs/reference/vscode/gists.mdx +++ b/docs/src/content/docs/reference/vscode/gists.mdx @@ -2,7 +2,18 @@ title: GitHub Gists description: Use gists to share GenAIScript code snippets. sidebar: - order: 20 + order: 20 +hero: + image: + alt: A simple 2D 8-bit style illustration at 128x128 pixels displays a geometric + computer screen with two overlapping windows. One window shows code + snippets, and the other features icons for version control. Additional + symbols include a cloud for sharing, a stylized lock symbolizing secret + content, a gear for settings, and a minimalistic folder. The color palette + uses five solid corporate colors in a flat, minimalist design with no + people, text, shadows, or background. + file: ./gists.png + --- [GitHub Gists](https://gist.github.com/) are a simple way to share code snippets and notes with others. diff --git a/docs/src/content/docs/reference/vscode/gists.png b/docs/src/content/docs/reference/vscode/gists.png new file mode 100644 index 0000000000..884fae4511 Binary files /dev/null and b/docs/src/content/docs/reference/vscode/gists.png differ diff --git a/docs/src/content/docs/reference/vscode/github-copilot-chat.mdx b/docs/src/content/docs/reference/vscode/github-copilot-chat.mdx index 3023b0f54f..632d8ca05f 100644 --- a/docs/src/content/docs/reference/vscode/github-copilot-chat.mdx +++ b/docs/src/content/docs/reference/vscode/github-copilot-chat.mdx @@ -12,6 +12,14 @@ keywords: - AI scripting - code automation - chat participants +hero: + image: + alt: A small, flat, abstract image uses five solid colors and geometric 8-bit + shapes to depict a chat bubble, a sheet of code with bracket symbols, an + AI chip, and a diagram block connected by thin lines. The icons are + arranged without backgrounds or text, all in a simple corporate style, + illustrating AI-driven chat and code integration. + file: ./github-copilot-chat.png --- diff --git a/docs/src/content/docs/reference/vscode/github-copilot-chat.png b/docs/src/content/docs/reference/vscode/github-copilot-chat.png new file mode 100644 index 0000000000..6ac225c8aa Binary files /dev/null and b/docs/src/content/docs/reference/vscode/github-copilot-chat.png differ diff --git a/docs/src/content/docs/reference/vscode/index.mdx b/docs/src/content/docs/reference/vscode/index.mdx index 7b6d66f869..6819224068 100644 --- a/docs/src/content/docs/reference/vscode/index.mdx +++ b/docs/src/content/docs/reference/vscode/index.mdx @@ -1,9 +1,20 @@ --- title: Overview sidebar: - order: 2 -description: Discover the features of the GenAIScript VSCode extension for script authoring, debugging, and deployment. + order: 2 +description: Discover the features of the GenAIScript VSCode extension for + script authoring, debugging, and deployment. keywords: VSCode extension, script authoring, debugging, deployment, installation +hero: + image: + alt: An 8-bit style icon features a blue Visual Studio Code logo, a basic + computer monitor displaying colored UI sections and simple code lines, and + a download arrow, all created with clean geometric shapes and five + distinct colors, set against a plain background with no people or text. + The design is minimalistic and corporate in appearance at a small, square + resolution. + file: ./index.png + --- GenAIScript is supported by a [Visual Studio Code](https://code.visualstudio.com/) extension diff --git a/docs/src/content/docs/reference/vscode/index.png b/docs/src/content/docs/reference/vscode/index.png new file mode 100644 index 0000000000..cf2a406a4a Binary files /dev/null and b/docs/src/content/docs/reference/vscode/index.png differ diff --git a/docs/src/content/docs/reference/vscode/running-scripts.mdx b/docs/src/content/docs/reference/vscode/running-scripts.mdx index 1208f7ecb5..14deff7493 100644 --- a/docs/src/content/docs/reference/vscode/running-scripts.mdx +++ b/docs/src/content/docs/reference/vscode/running-scripts.mdx @@ -1,9 +1,21 @@ --- title: Running Scripts sidebar: - order: 3 -description: Learn how to run GenAIScripts in Visual Studio Code using the GenAIScript extension. + order: 3 +description: Learn how to run GenAIScripts in Visual Studio Code using the + GenAIScript extension. keywords: GenAIScript, Visual Studio Code, run scripts, command palette, context menu +hero: + image: + alt: "An 8-bit style image displays a basic computer screen set at a small + square size. On screen are geometric icons: a script file with a play + button, a file explorer showing several files and folders, and one + file—labeled as .gitignore—stands out with a highlight. The palette uses + only five businesslike colors; the graphics are flat, minimal, and use + simple shapes, with no background, shading, or words. Everything is + arranged for a tidy, iconic appearance." + file: ./running-scripts.png + --- import { YouTube } from "astro-embed" diff --git a/docs/src/content/docs/reference/vscode/running-scripts.png b/docs/src/content/docs/reference/vscode/running-scripts.png new file mode 100644 index 0000000000..1d6136bb52 Binary files /dev/null and b/docs/src/content/docs/reference/vscode/running-scripts.png differ diff --git a/docs/src/content/docs/reference/vscode/settings.mdx b/docs/src/content/docs/reference/vscode/settings.mdx index dd7f7bfaa3..9584f3b919 100644 --- a/docs/src/content/docs/reference/vscode/settings.mdx +++ b/docs/src/content/docs/reference/vscode/settings.mdx @@ -1,8 +1,19 @@ --- title: Settings sidebar: - order: 5 + order: 5 description: List of settings available in Visual Studio Code. +hero: + image: + alt: A small, square 8-bit style image shows a simplified computer monitor on a + plain white background. The monitor screen contains graphic + representations of adjustment sliders and toggle switches, all depicted + with clean, flat shapes. The overall design uses five distinct, solid + colors reminiscent of Visual Studio Code’s palette, arranged minimally + with no people, writing, shadows, gradients, or reflections. The image is + highly geometric and stylized, measuring 128 by 128 pixels. + file: ./settings.png + --- import VisualStudioCodeSettings from "../../../../components/VisualStudioCodeSettings.astro" diff --git a/docs/src/content/docs/reference/vscode/settings.png b/docs/src/content/docs/reference/vscode/settings.png new file mode 100644 index 0000000000..4075ec41b3 Binary files /dev/null and b/docs/src/content/docs/reference/vscode/settings.png differ diff --git a/package.json b/package.json index f0d8d8d081..2566db6651 100644 --- a/package.json +++ b/package.json @@ -81,7 +81,8 @@ "genai:tweetify": "node packages/cli/built/genaiscript.cjs run tweetify", "genai:docify": "node packages/cli/built/genaiscript.cjs run docify", "genai:debugify": "node packages/cli/built/genaiscript.cjs run dbg-if", - "genai:blog-images": "node packages/cli/built/genaiscript.cjs convert blog-image docs/src/content/docs/blog/*.md*", + "genai:blog-images": "node packages/cli/built/genaiscript.cjs convert blog-image \"docs/src/content/docs/blog/*.md*\" --no-run-trace --no-output-trace", + "genai:docs-images": "node packages/cli/built/genaiscript.cjs convert docs-image \"docs/src/content/docs/getting-started/**/*.md*\" \"docs/src/content/docs/reference/**/*.md*\" --no-run-trace --no-output-trace", "commit": "yarn pretty && yarn compile && yarn test:core && yarn gcm", "gcm": "node packages/cli/built/genaiscript.cjs run gcm --model gcm", "prd": "node packages/cli/built/genaiscript.cjs run prd -prd --model github:gpt-4.1 --vars base=dev",