Publish launch (#830)

.github/workflows/deploy-docs-and-extensions.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Install dependencies and build docs
         working-directory: ./documentation
         env:
-          INKEEP_API_KEY: ${{ secrets.INKEEP_API_KEY }}
+          INKEEP_API_KEY: ${{ secrets.INKEEP_API_KEY }} // Keys for Inkeep search and chatbot.
           INKEEP_INTEGRATION_ID: ${{ secrets.INKEEP_INTEGRATION_ID }}
           INKEEP_ORG_ID: ${{ secrets.INKEEP_ORG_ID }}
         run: |
@@ -40,12 +40,13 @@ jobs:
         run: |
           mkdir combined-build
           cp -r documentation/build/* combined-build/
-          mkdir -p combined-build/extensions
-          cp -r extensions-site/build/client/* combined-build/extensions/
+          mkdir -p combined-build/v1/extensions
+          cp -r extensions-site/build/client/* combined-build/v1/extensions/
 
-      - name: Deploy to gh-pages
+      - name: Deploy to /gh-pages
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: combined-build
-          destination_dir: v1 # Deploy the site to the 'v1' subfolder
+          destination_dir: . # Deploy the site to the root /goose directory
+      

README.md

@@ -18,5 +18,5 @@ codename goose
   </a>
 </p>
 
-Check out our [documentation](https://block.github.io/goose/v1/), or to try it out head to the [installation](https://block.github.io/goose/v1/docs/getting-started/installation) instructions!
+Check out our [documentation](https://block.github.io/goose), or to try it out head to the [installation](https://block.github.io/goose/docs/getting-started/installation) instructions!
 

documentation/docs/guides/tips.md

@@ -46,5 +46,5 @@ It doesn't have to be in a repo. Just ask Goose!
 ### Keep Goose updated
 Regularly update Goose to benefit from the latest features, bug fixes, and performance improvements. For the CLI, the best way to keep it updated is by re-running the [Goose installation script][installation]. For Goose Desktop, check the [GitHub Releases page][ui-release] regularly for updates.
 
-[installation]: https://block.github.io/goose/v1/docs/quickstart/#installation
+[installation]: https://block.github.io/goose/docs/quickstart/#installation
 [ui-release]: https://github.com/block/goose/releases/stable

documentation/docusaurus.config.ts

@@ -20,7 +20,7 @@ const config: Config = {
   url: "https://block.github.io/",
   // Set the /<baseUrl>/ pathname under which your site is served
   // For GitHub pages deployment, it is often '/<projectName>/'
-  baseUrl: "/goose/v1/",
+  baseUrl: "/goose/",
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
@@ -62,7 +62,31 @@ const config: Config = {
       } satisfies Preset.Options,
     ],
   ],
-
+  plugins: [
+    [
+      "@docusaurus/plugin-client-redirects",
+      {
+        redirects: [
+          {
+            to: '/docs/getting-started/providers',
+            from: '/v1/docs/getting-started/providers',
+          },
+          {
+            to: '/docs/getting-started/installation',
+            from: '/v1/docs/getting-started/installation',
+          },
+          {
+            to: '/docs/getting-started/quickstart',
+            from: '/v1/docs/getting-started/quickstart',
+          },
+          {
+            to: '/',
+            from: '/v1/',
+          }
+        ],
+      },
+    ],
+  ],
   themes: ["@inkeep/docusaurus/chatButton", "@inkeep/docusaurus/searchBar"],
   themeConfig: {
     // Replace with your project's social card
@@ -173,9 +197,7 @@ const config: Config = {
       aiChatSettings: {
         chatSubjectName: "goose",
         botAvatarSrcUrl:
-          "https://storage.googleapis.com/organization-image-assets/block-botAvatarSrcUrl-1737745528096.png",
-        botAvatarDarkSrcUrl:
-          "https://storage.googleapis.com/organization-image-assets/block-botAvatarDarkSrcUrl-1737745527450.png",
+          "",
         getHelpCallToActions: [
           {
             name: "GitHub",

documentation/package-lock.json

@@ -9,6 +9,7 @@
       "version": "0.0.0",
       "dependencies": {
         "@docusaurus/core": "3.7.0",
+        "@docusaurus/plugin-client-redirects": "^3.7.0",
         "@docusaurus/preset-classic": "3.7.0",
         "@inkeep/docusaurus": "^2.0.16",
         "@mdx-js/react": "^3.0.0",
@@ -3291,6 +3292,30 @@
         "react-dom": "*"
       }
     },
+    "node_modules/@docusaurus/plugin-client-redirects": {
+      "version": "3.7.0",
+      "resolved": "https://registry.npmjs.org/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-3.7.0.tgz",
+      "integrity": "sha512-6B4XAtE5ZVKOyhPgpgMkb7LwCkN+Hgd4vOnlbwR8nCdTQhLjz8MHbGlwwvZ/cay2SPNRX5KssqKAlcHVZP2m8g==",
+      "license": "MIT",
+      "dependencies": {
+        "@docusaurus/core": "3.7.0",
+        "@docusaurus/logger": "3.7.0",
+        "@docusaurus/utils": "3.7.0",
+        "@docusaurus/utils-common": "3.7.0",
+        "@docusaurus/utils-validation": "3.7.0",
+        "eta": "^2.2.0",
+        "fs-extra": "^11.1.1",
+        "lodash": "^4.17.21",
+        "tslib": "^2.6.0"
+      },
+      "engines": {
+        "node": ">=18.0"
+      },
+      "peerDependencies": {
+        "react": "^18.0.0 || ^19.0.0",
+        "react-dom": "^18.0.0 || ^19.0.0"
+      }
+    },
     "node_modules/@docusaurus/plugin-content-blog": {
       "version": "3.7.0",
       "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.7.0.tgz",

documentation/package.json

@@ -16,6 +16,7 @@
   },
   "dependencies": {
     "@docusaurus/core": "3.7.0",
+    "@docusaurus/plugin-client-redirects": "^3.7.0",
     "@docusaurus/preset-classic": "3.7.0",
     "@inkeep/docusaurus": "^2.0.16",
     "@mdx-js/react": "^3.0.0",

documentation/static/img/bot.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-bot"><path d="M12 8V4H8"/><rect width="16" height="12" x="4" y="8" rx="2"/><path d="M2 14h2"/><path d="M20 14h2"/><path d="M15 13v2"/><path d="M9 13v2"/></svg>

ui/desktop/src/components/welcome_screen/WelcomeScreen.tsx

@@ -72,7 +72,7 @@ export function WelcomeScreen({ onSubmit }: WelcomeScreenProps) {
                   variant="link"
                   className="text-blue-500 hover:text-blue-600 p-0 h-auto"
                   onClick={() =>
-                    window.open('https://block.github.io/goose/v1/docs/quickstart', '_blank')
+                    window.open('https://block.github.io/goose/docs/quickstart', '_blank')
                   }
                 >
                   Quick Start Guide