refactor: change structure of docs site

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

Author: tylerslaton

docs/docs/tools/01-authoring/01-overview.md renamed to docs/docs/100-tools/01-using.md

@@ -1,9 +1,6 @@
-# Overview
-
+# Using Tools
 In GPTScript, tools are used to extend the capabilities of a script. The idea behind them is that AI performs better when it has very specific instructions for a given task. Tools are a way to break-up the problem into smaller and more focused pieces where each tool is responsible for a specific task. A typical flow like this is to have a main script that imports a set of tools it can use to accomplish its goal.
 
-## Using Tools
-
 GPTScripts can utilize tools in one of three ways:
 1. Built-in system tools
 2. In-script tools
@@ -50,21 +47,3 @@ Take this image and search the web for similar images. Write links for the top 5
 ```
 
 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.
-
-## Authoring External Tools
-You can author your own tools for your own 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.
-
-Here's an example of the `tool.gpt` file for the `image-generation` tool:
-
-```yaml
-description: I am a tool that can generate images based on arguments that are sent to me. I return a list of URLs to the generated images.
-args: prompt: (required) The text prompt based on which the GPT model will generate a response
-args: model: (optional) The model to use for image generation. Defaults to "dall-e-3".
-args: size: (optional) The size of the image to generate, format WxH (e.g. 1024x1024). Defaults to 1024x1024.
-args: quality: (optional) The quality of the generated image. Allowed values are "standard" or "hd". Default is "standard".
-args: number: (optional) The number of images to generate. Defaults to 1.
-
-#!/usr/bin/env python3 ./cli.py --prompt="${prompt}" --model="${model}" --size="${size}" --quality="${quality}" --number="${number}"
-```
-
-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.

docs/docs/tools/01-authoring/02-binary-tools.md renamed to docs/docs/100-tools/02-authoring.md

@@ -1,4 +1,23 @@
-# Binary Tools
+# 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.
+
+Here's an example of the `tool.gpt` file for the `image-generation` tool:
+
+```yaml
+description: I am a tool that can generate images based on arguments that are sent to me. I return a list of URLs to the generated images.
+args: prompt: (required) The text prompt based on which the GPT model will generate a response
+args: model: (optional) The model to use for image generation. Defaults to "dall-e-3".
+args: size: (optional) The size of the image to generate, format WxH (e.g. 1024x1024). Defaults to 1024x1024.
+args: quality: (optional) The quality of the generated image. Allowed values are "standard" or "hd". Default is "standard".
+args: number: (optional) The number of images to generate. Defaults to 1.
+
+#!/usr/bin/env python3 ./cli.py --prompt="${prompt}" --model="${model}" --size="${size}" --quality="${quality}" --number="${number}"
+```
+
+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.
+
+## 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.
 
 For example:

docs/docs/tools/02-offerings/01-image-generation.md renamed to docs/docs/100-tools/03-offerings/01-image-generation.md

@@ -1,23 +1,34 @@
 # Image Generation
 
-## Overview
-
 The `image-generation` tool leverages OpenAI's DALL-E model to convert textual descriptions into images. It offers a versatile approach to creating visual content, making it suitable for a wide range of applications, from content creation to design assistance.
 
 For more information, check out the tool [here](https://github.com/gptscript-ai/image-generation)
 
+## Installation
+We are working on an process where installation of tools will be as simple as
+referencing the tool's link in your GPTScript. For now, you can follow the steps below to install the image-generation tool.
+
+1. Clone the image-generation tool repository [from GitHub](https://github.com/gptscript-ai/image-generation).
+
+```shell
+git clone https://github.com/gptscript-ai/image-generation
+```
+
+2. Run `make bootstrap` to setup the python venv and install the required dependencies.
+
+```shell
+make bootstrap
+```
+
+3. Reference `<path-to-the-repo>/tool.gpt` in your GPTScript.
+
 ## Usage
 To use the Image Generation tool, you need to make sure that the OPENAI_API_KEY environment variable is set to your OpenAI API key. You can obtain an API key from the OpenAI platform if you don't already have one.
 
 With that setup, you can use it in any GPTScript like so:
 
-:::tip
-This script assumes you have the `image-generation` tool repo cloned locally and located at `./image-generation`. The ability to import tools from remote
-locations is coming soon.
-:::
-
 ```
-tools: ./image-generation, sys.write
+tools: ./image-generation/tool.gpt, sys.download, sys.write
 
 Generate an image of a city skyline at night with a resolution of 512x512 pixels.
 

docs/docs/tools/02-offerings/02-system.md renamed to docs/docs/100-tools/03-offerings/02-system.md

@@ -104,3 +104,12 @@ Writes content to a specified file.
 
 - `content`: The content to be written to the file.
 - `filename`: The filename where the content should be written.
+
+## sys.append
+
+Appends the contents to a file.
+
+#### Arguments
+
+- `content`: The content to append.
+- `filename`: The name of the file to append to.

docs/docs/100-tools/03-offerings/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Offerings",
+  "collapsible": true,
+  "link": {
+    "type": "generated-index",
+    "title": "Offerings"
+  }
+}

docs/docs/tools/tools.md renamed to docs/docs/100-tools/100-tools.md

@@ -0,0 +1,3 @@
+{
+  "label": "Tools"
+}

docs/docs/100-tools/_category_.json

@@ -0,0 +1,11 @@
+{
+  "label": "Cookbook",
+  "collapsible": true,
+  "link": {
+    "type": "generated-index",
+    "title": "Cookbook"
+  },
+  "customProps": {
+    "description": "Explore the various things you can do with GPTScript and how to do them."
+  }
+}