Skip to content

Commit

Permalink
more images in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pelikhan committed Mar 29, 2024
1 parent e2cd466 commit 174874c
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 7 deletions.
Binary file added docs/src/assets/vscode-file-run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/vscode-folder-run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/vscode-statusbar-trace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 13 additions & 6 deletions docs/src/content/docs/getting-started/running-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,31 @@ In Visual Studio Code, the location where you start running a script determines

## Single file

- Right click on a file in the Explorer and select `Run GenAIScript`.
- Or right click in a file editor and select `Run GenAIScript`.
- Right click on a file in the Explorer and select **Run GenAIScript...**.
- Or right click in a file editor and select **Run GenAIScript...**.

The `env.files` array will contain a single element with the selected file.

![Context menu to run GenAIScript on a file](../../../assets/vscode-file-run.png)

The `env.files` will contain a single element with the selected file.

## Folder

- Right click on a folder in the Explorer and select `Run GenAIScript`.
- Right click on a folder in the Explorer and select **Run GenAIScript...**s.

The `env.files` will contain all nested files under that folder.
The `env.files` array will contain all nested files under that folder.

![Context menu to run GenAIScript on a folder](../../../assets/vscode-folder-run.png)

## Analyze results

By default, GenAIScript opens the output preview which shows a rendered view of the LLM output (assuming the LLM produces markdown).

You can also use the **Trace** to review the each transformation step of the script execution.

- Click on the GenAIScript status bar and select `Trace`
- Click on the GenAIScript status bar icon and select **Trace**

![Menu opened by clicking the vscode status bar](../../../assets/vscode-statusbar-trace.png)

## Next steps

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/reference/scripts/specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar:
order: 100
---

To start using GenAIScript, create a new `.gpspec.md` file and start adding content as markdown. Right click and run "Run GenAIScript" to see the results.
To start using GenAIScript, create a new `.gpspec.md` file and start adding content as markdown. Right click and run **Run GenAIScript...** to see the results.

```markdown
# email address recognizer
Expand Down

0 comments on commit 174874c

Please sign in to comment.