docs: address code review

Signed-off-by: tylerslaton <[email protected]>

Author: tylerslaton

README.md

@@ -2,9 +2,9 @@
 
 ## Overview
 
-GPTScript is a new scripting language to automate your interaction with a Large Language Model (LLM), namely OpenAI. The ultimate goal is to create a fully natural language based programming experience. The syntax of GPTScript is largely natural language, making it very easy to learn and use.
+GPTScript is a new scripting language to automate your interaction with a Large Language Model (LLM), namely OpenAI. The ultimate goal is to create a natural language programming experience. The syntax of GPTScript is largely natural language, making it very easy to learn and use.
 Natural language prompts can be mixed with traditional scripts such as bash and python or even external HTTP service
-calls. With GPTScript you can do just about anything like [plan a vacation](./examples/travel-agent.gpt),
+calls. With GPTScript you can do just about anything, like [plan a vacation](./examples/travel-agent.gpt),
 [edit a file](./examples/add-go-mod-dep.gpt), [run some SQL](./examples/sqlite-download.gpt), or [build a mongodb/flask app](./examples/hacker-news-headlines.gpt).
 
 ```yaml
@@ -175,7 +175,7 @@ Description: Tool description
 # This tool can invoke tool1 or tool2 if needed
 Tools: tool1, tool2
 Args: arg1: The description of arg1
-      
+
 Tool instructions go here.
 ```
 #### Tool Parameters
@@ -228,7 +228,7 @@ description: A tool that echos the input
 args: input: The input
 
 #!/bin/bash
-        
+
 echo "${input}"
 ```
 
@@ -247,7 +247,7 @@ Join us on Discord: [![Discord](https://img.shields.io/discord/12045584209848648
 
 ## License
 
-Copyright (c) 2023 [Acorn Labs, Inc.](http://acorn.io)
+Copyright (c) 2024 [Acorn Labs, Inc.](http://acorn.io)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

docs/docs/01-overview.md

@@ -3,10 +3,10 @@ title: Overview
 slug: /
 ---
 
-GPTScript is a new scripting language to automate your interaction with a Large Language Model (LLM), namely OpenAI. The ultimate goal is to create a fully natural language based programming experience. The syntax of GPTScript is largely natural language, making it very easy to learn and use. Natural language prompts can be mixed with traditional scripts such as bash and python or even external HTTP service calls. With GPTScript you can do just about anything like [plan a vacation](https://github.com/gptscript-ai/gptscript/blob/main/examples/travel-agent.gpt), [edit a file](https://github.com/gptscript-ai/gptscript/blob/main/examples/add-go-mod-dep.gpt), [run some SQL](https://github.com/gptscript-ai/gptscript/blob/main/examples/sqlite-download.gpt), or [build a mongodb/flask app](https://github.com/gptscript-ai/gptscript/blob/main/examples/hacker-news-headlines.gpt).
+GPTScript is a new scripting language to automate your interaction with a Large Language Model (LLM), namely OpenAI. The ultimate goal is to create a natural language programming experience. The syntax of GPTScript is largely natural language, making it very easy to learn and use. Natural language prompts can be mixed with traditional scripts such as bash and python or even external HTTP service calls. With GPTScript you can do just about anything, like [plan a vacation](https://github.com/gptscript-ai/gptscript/blob/main/examples/travel-agent.gpt), [edit a file](https://github.com/gptscript-ai/gptscript/blob/main/examples/add-go-mod-dep.gpt), [run some SQL](https://github.com/gptscript-ai/gptscript/blob/main/examples/sqlite-download.gpt), or [build a mongodb/flask app](https://github.com/gptscript-ai/gptscript/blob/main/examples/hacker-news-headlines.gpt).
 
 :::note
-We are currently exploring options for interacting with GPTScript using local models.
+We are currently exploring options for interacting with local models using GPTScript.
 :::
 
 ```yaml

docs/docs/100-tools/01-using.md

@@ -12,7 +12,7 @@ All GPTScripts have access to system tools, like `sys.read` and `sys.write`, tha
 ```yaml
 tools: sys.read, sys.write
 
-Read all of the files in my current directory, do no recurse over any subdirectories, and give me a description of this directory's contents.s
+Read all of the files in my current directory, do not recurse over any subdirectories, and give me a description of this directory's contents.
 ```
 
 System tools are a set of core tools that come packaged with GPTScript by default.
@@ -38,12 +38,16 @@ Select a number at random between 1 and 100 and return only the number.
 
 This is where the real power of GPTScript starts to become evident. For this example lets use the external [image-generation](https://github.com/gptscript-ai/image-generation) and [search](https://github.com/gptscript-ai/search) tools to generate an image and then search the web for similar images.
 
+:::note
+There will be better packaging and distribution for external tools in the future. For now, this assumes you have the tools cloned locally and are pointing to their repos directly.
+:::
+
 ```yaml
-tools: ./image-generation/tool.gpt, ./search, sys.read
+tools: ./image-generation/tool.gpt, ./vision/tool.gpt, sys.read
 
 Generate an image of a city skyline at night and write the resulting image to a file called city_skyline.png.
 
-Take this image and search the web for similar images. Write links for the top 5 results to a file called similar_images.txt.
+Take this image and write a description of it in the style of pirate.
 ```
 
 External tools are tools that are defined by a `tool.gpt` file in their root directory. They can be imported into a GPTScript by specifying the path to the tool's root directory.

docs/docs/100-tools/02-authoring.md

@@ -1,6 +1,6 @@
 # Authoring Tools
 
-You can author your own tools for your use or to share with others. The process for authoring a tool is as simple as creating a `tool.gpt` file in the root directory of your tool This file is itself a GPTScript that defines the tool's name, description, and what it should do.
+You can author your own tools for your use or to share with others. The process for authoring a tool is as simple as creating a `tool.gpt` file in the root directory of your project. This file is itself a GPTScript that defines the tool's name, description, and what it should do.
 
 Here's an example of the `tool.gpt` file for the `image-generation` tool:
 
@@ -17,6 +17,10 @@ args: number: (optional) The number of images to generate. Defaults to 1.
 
 At the bottom you'll notice a shebang line that specifies the command to run when the tool is invoked. This is the exact command that will be executed when the tool is used in a GPTScript. Doing this with tools allows for a high degree of reliability that the tool would not otherwise have.
 
+:::tip
+Every arg becomes an environment variable when the tool is invoked.
+:::
+
 ## Binary Tools
 GPTScript can call binaries and scripts located on your system or externally. This is done by defining a `tool.gpt` file in the same directory that the binary or script is located. In that `tool.gpt` file, you call it directly using the `#!` directive.