Restructure docs

block · Jan 22, 2025 · b2b7a01 · b2b7a01
1 parent c93728e
commit b2b7a01
Show file tree

Hide file tree

Showing 25 changed files with 52 additions and 290 deletions.
diff --git a/documentation/docs/configuration/_category_.json b/documentation/docs/configuration/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Configuration",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "Extend goose functionalities with extensions and custom configurations"
+  }
+}
diff --git a/documentation/docs/extensions.md → ...entation/docs/configuration/extensions.md b/documentation/docs/extensions.md → ...entation/docs/configuration/extensions.md
diff --git a/documentation/docs/managing-extensions.md → ...docs/configuration/managing-extensions.md b/documentation/docs/managing-extensions.md → ...docs/configuration/managing-extensions.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 2
 title: Managing Goose Extensions
 ---
 

diff --git a/documentation/docs/plugins/providers.md → ...mentation/docs/configuration/providers.md b/documentation/docs/plugins/providers.md → ...mentation/docs/configuration/providers.md
@@ -1,4 +1,8 @@
-# Providers
+---
+sidebar_position: 1
+---
+
+# Supported Providers
 
 Providers in Goose mean "LLM providers" that Goose can interact with. Providers are defined in the [Exchange library][exchange-providers] for the most part, but you can define your own.
 

diff --git a/...entation/docs/guidance/getting-started.md → documentation/docs/getting-started.md b/...entation/docs/guidance/getting-started.md → documentation/docs/getting-started.md
diff --git a/documentation/docs/getting-started/_category_.json b/documentation/docs/getting-started/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Getting Started",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Get up to speed quickly with Goose"
+  }
+}
diff --git a/...entation/docs/guidance/goose-in-action.md → ...tion/docs/getting-started/applications.md b/...entation/docs/guidance/goose-in-action.md → ...tion/docs/getting-started/applications.md
@@ -1,3 +1,24 @@
+---
+sidebar_position: 3
+title: Applications of Goose
+---
+
+# Uses of Goose so Far
+
+We've been using Goose to help us with a variety of tasks. Here are some examples:
+
+- Conduct code migrations like:
+    - Ember to React
+    - Ruby to Kotlin
+    - Prefect-1 to Prefect-2
+- Dive into a new project in an unfamiliar coding language
+- Transition a code-base from field-based injection to constructor-based injection in a dependency injection framework
+- Conduct performance benchmarks for a build command using a build automation tool
+- Increasing code coverage above a specific threshold
+- Scaffolding an API for data retention
+- Creating Datadog monitors
+- Removing or adding feature flags
+
 # Goose in action
 
 This page is frequently updated with the latest use-cases and applications of Goose!

diff --git a/documentation/docs/configuration.md → .../docs/getting-started/using-extensions.md b/documentation/docs/configuration.md → .../docs/getting-started/using-extensions.md
@@ -1,5 +1,6 @@
 ---
-title: Configuration
+sidebar_position: 2
+title: Using Extensions
 ---
 # Configuring Goose
 

diff --git a/...ntation/docs/guidance/using-goose-free.md → .../docs/getting-started/using-goose-free.md b/...ntation/docs/guidance/using-goose-free.md → .../docs/getting-started/using-goose-free.md
@@ -1,4 +1,5 @@
 ---
+sidebar_position: 1
 title: Using Goose for Free
 ---
 

diff --git a/documentation/docs/guidance/applications.md b/documentation/docs/guidance/applications.md
diff --git a/documentation/docs/guidance/_category_.json → documentation/docs/guides/_category_.json b/documentation/docs/guidance/_category_.json → documentation/docs/guides/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Guides",
-  "position": 5,
+  "position": 4,
   "link": {
     "type": "generated-index",
     "description": "Learn essential tips and recommendations for using Goose"

diff --git a/documentation/docs/guides/file-management.md b/documentation/docs/guides/file-management.md
diff --git a/documentation/docs/plugins/cli.md → ...ntation/docs/guides/goose-cli-commands.md b/documentation/docs/plugins/cli.md → ...ntation/docs/guides/goose-cli-commands.md
diff --git a/...ce/handling-llm-rate-limits-with-goose.md → ...es/handling-llm-rate-limits-with-goose.md b/...ce/handling-llm-rate-limits-with-goose.md → ...es/handling-llm-rate-limits-with-goose.md
diff --git a/.../docs/guidance/managing-goose-sessions.md → ...on/docs/guides/managing-goose-sessions.md b/.../docs/guidance/managing-goose-sessions.md → ...on/docs/guides/managing-goose-sessions.md
diff --git a/documentation/docs/guidance/tips.md → documentation/docs/guides/tips.md b/documentation/docs/guidance/tips.md → documentation/docs/guides/tips.md
diff --git a/...ntation/docs/guidance/using-goosehints.md → ...mentation/docs/guides/using-goosehints.md b/...ntation/docs/guidance/using-goosehints.md → ...mentation/docs/guides/using-goosehints.md
diff --git a/documentation/docs/installation.md b/documentation/docs/installation.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 1
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';

diff --git a/documentation/docs/plugins/_category_.json b/documentation/docs/plugins/_category_.json
diff --git a/documentation/docs/plugins/available-toolkits.md b/documentation/docs/plugins/available-toolkits.md
diff --git a/documentation/docs/plugins/plugins.md b/documentation/docs/plugins/plugins.md
diff --git a/documentation/docs/plugins/using-toolkits.md b/documentation/docs/plugins/using-toolkits.md
diff --git a/documentation/docs/quickstart.md b/documentation/docs/quickstart.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 2
 title: Quickstart
 ---
 

diff --git a/documentation/docs/run_cross_local.md b/documentation/docs/run_cross_local.md
@@ -1,3 +1,6 @@
+---
+draft: true
+---
 # Instructions for running cross to test release builds locally
 
 ## Prerequisites

diff --git a/documentation/docs/errors.md → documentation/docs/troubleshooting.md b/documentation/docs/errors.md → documentation/docs/troubleshooting.md