create plugins section

block · Sep 17, 2024 · 16f6b66 · 16f6b66
1 parent d8828e7
commit 16f6b66
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 8 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributing
 
-<p align="center">
+<p>
 <a href="#prerequisites">Prerequisites</a> •
 <a href="#evaluations">Evaluations</a> •
 <a href="#developing-and-testing">Developing and testing</a> •

diff --git a/docs/docs/creating-a-new-toolkit.md b/docs/docs/creating-a-new-toolkit.md
@@ -69,7 +69,7 @@ default:
   toolkits:
     - name: developer
       requires: {}
-demo:
+demo-profile:
   provider: openai
   processor: gpt-4o
   accelerator: gpt-4o-mini
@@ -82,7 +82,7 @@ demo:
 And now you can run goose with this new profile to use the new toolkit!
 
 ```sh
-goose session start --profile demo
+goose session start --profile demo-profile
 ```
 
 > [!NOTE]

diff --git a/docs/docs/plugins.md b/docs/docs/plugins.md
@@ -0,0 +1,15 @@
+# Plugins in Goose
+
+Goose's functionality is extended via plugins. These plugins fall into three main categories:
+
+1. **Toolkits**: 
+    * Provides Goose with tools (functions) it can call and optionally will load additional context into the system prompt (such as 'The Github CLI is called via `gh` and you should use it to run git commands'). 
+    * Toolkits can do basically anything, from calling external APIs, to taking a screenshot of your screen, to summarizing your current project.
+2. **CLI commands**: 
+    * Provides additional commands to the Goose CLI. 
+    * These commands can be used to interact with the Goose system, such as listing available toolkits or summarizing a session.
+3. **Providers**: 
+    * Provides Goose with access to external LLMs. 
+    * For example, the OpenAI provider allows Goose to interact with the OpenAI API. 
+    * Most providers for Goose are defined in the Exchange library.
+
diff --git a/docs/docs/providers.md b/docs/docs/providers.md
@@ -0,0 +1,3 @@
+# Providers
+
+Providers in Goose mean "LLM providers" that Goose can interact with. Providers are defined in the Exchange library for the most part, but you can define your own. 
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -97,9 +97,14 @@ nav:
   - 'Installation': installation.md
   - 'Configuration': configuration.md
   - 'Contributing': contributing.md
-  - Toolkits:
-      - 'Using Toolkits': using-toolkits.md
-      - 'Creating a New Toolkit': creating-a-new-toolkit.md
-      - 'Available Toolkits': available-toolkits.md
-  - 'CLI Commands': cli.md
+  - Plugins:
+    - 'Overview': plugins.md
+    - Toolkits:
+        - 'Using Toolkits': using-toolkits.md
+        - 'Creating a New Toolkit': creating-a-new-toolkit.md
+        - 'Available Toolkits': available-toolkits.md
+    - CLI Commands:
+        - 'Available CLI Commands': cli.md
+    - Providers:
+        - 'Available Providers': providers.md
   - 'Tips': tips.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Providers

		Providers in Goose mean "LLM providers" that Goose can interact with. Providers are defined in the Exchange library for the most part, but you can define your own.