docs: integrate Pagefind search, Google Analytics, and feedback buttons

.ci/lint-docs-source-page.sh

@@ -118,4 +118,4 @@ if has_errors:
     sys.exit(1)
 print("Success: Source pages validated.")
 sys.exit(0)
-EOF
+EOF

.ci/lint-docs-tool-page.sh

@@ -132,4 +132,4 @@ if has_errors:
     sys.exit(1)
 else:
     print("Success: All Tool pages passed structure validation.")
-EOF
+EOF

.github/workflows/deploy_dev_docs.yaml

@@ -69,6 +69,9 @@ jobs:
           HUGO_BASEURL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/dev
           HUGO_RELATIVEURLS: false
 
+      - name: Build Pagefind Search Index
+        run: npx pagefind --site public
+
       - name: Create Staging Directory
         run: |
           mkdir staging

.github/workflows/deploy_previous_version_docs.yaml

@@ -73,6 +73,10 @@ jobs:
           HUGO_RELATIVEURLS: false
           HUGO_PARAMS_VERSION: ${{ github.event.inputs.version_tag }}
 
+      - name: Build Pagefind Index (Archived Version)
+        run: npx pagefind --site public
+        working-directory: .hugo
+
       - name: Deploy to gh-pages
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
         with:
@@ -95,6 +99,10 @@ jobs:
           HUGO_RELATIVEURLS: false
           HUGO_PARAMS_VERSION: ${{ github.event.inputs.version_tag }}
 
+      - name: Build Pagefind Index (Root)
+        run: npx pagefind --site public
+        working-directory: .hugo
+
       - name: Deploy to root
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
         with:
@@ -103,4 +111,4 @@ jobs:
           publish_branch: versioned-gh-pages
           keep_files: true
           allow_empty_commit: true
-          commit_message: "deploy: docs to root for ${{ github.event.inputs.version_tag }}"
+          commit_message: "deploy: docs to root for ${{ github.event.inputs.version_tag }}"

.github/workflows/deploy_previous_version_docs_to_cf.yaml

@@ -73,6 +73,10 @@ jobs:
           HUGO_RELATIVEURLS: false
           HUGO_PARAMS_VERSION: ${{ github.event.inputs.version_tag }}
 
+      - name: Build Pagefind Index (Root)
+        run: npx pagefind --site public
+        working-directory: .hugo
+
       - name: Deploy to cloudflare-pages
         uses: peaceiris/actions-gh-pages@v4
         with:
@@ -95,6 +99,10 @@ jobs:
           HUGO_RELATIVEURLS: false
           HUGO_PARAMS_VERSION: ${{ github.event.inputs.version_tag }}
 
+      - name: Build Pagefind Index (Root)
+        run: npx pagefind --site public
+        working-directory: .hugo
+
       - name: Deploy to root
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
         with:

.github/workflows/deploy_versioned_docs.yaml

@@ -63,6 +63,10 @@ jobs:
           HUGO_RELATIVEURLS: false
           HUGO_PARAMS_VERSION: ${{ steps.get_version.outputs.VERSION }}
 
+      - name: Build Pagefind Index (Versioned)
+        run: npx pagefind --site public
+        working-directory: .hugo
+
       - name: Deploy
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
         with:
@@ -84,6 +88,10 @@ jobs:
           HUGO_RELATIVEURLS: false
           HUGO_PARAMS_VERSION: ${{ steps.get_version.outputs.VERSION }}
 
+      - name: Build Pagefind Index (Root)
+        run: npx pagefind --site public
+        working-directory: .hugo
+
       - name: Deploy to root
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
         with:

.github/workflows/deploy_versioned_docs_to_cf.yaml

@@ -63,6 +63,10 @@ jobs:
           HUGO_RELATIVEURLS: false
           HUGO_PARAMS_VERSION: ${{ steps.get_version.outputs.VERSION }}
 
+      - name: Build Pagefind Index (Root)
+        run: npx pagefind --site public
+        working-directory: .hugo
+
       - name: Deploy
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
         with:
@@ -84,6 +88,10 @@ jobs:
           HUGO_RELATIVEURLS: false
           HUGO_PARAMS_VERSION: ${{ steps.get_version.outputs.VERSION }}
 
+      - name: Build Pagefind Index (Root)
+        run: npx pagefind --site public
+        working-directory: .hugo
+
       - name: Deploy to root
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
         with:

.github/workflows/docs_preview_deploy.yaml

@@ -17,7 +17,7 @@ name: "docs"
 permissions:
   contents: write
   pull-requests: write
-  
+
 # This Workflow depends on 'github.event.number',
 # not compatible with branch or manual triggers.
 on:
@@ -81,6 +81,9 @@ jobs:
           HUGO_ENVIRONMENT: preview
           HUGO_RELATIVEURLS: false
 
+      - name: Build Pagefind Search Index
+        run: npx pagefind --site public
+
       - name: Deploy
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4
         with:

.github/workflows/docs_preview_deploy_cf.yaml

@@ -72,6 +72,9 @@ jobs:
           HUGO_ENVIRONMENT: preview
           HUGO_RELATIVEURLS: false
 
+      - name: Build Pagefind Search Index
+        run: npx pagefind --site public
+
       - name: Deploy to Cloudflare Pages via Wrangler
         id: cf_deploy
         uses: cloudflare/wrangler-action@v3

.gitignore

@@ -13,6 +13,7 @@ node_modules
 # hugo
 .hugo/public/
 .hugo/resources/_gen
+.hugo/static/pagefind/
 .hugo_build.lock
 
 # coverage

.hugo/hugo.cloudflare.toml

@@ -49,18 +49,25 @@ ignoreFiles = ["quickstart/shared", "quickstart/python", "quickstart/js", "quick
   github_repo = "https://github.com/googleapis/genai-toolbox"
   github_project_repo = "https://github.com/googleapis/genai-toolbox"
   github_subdir = "docs"
-  offlineSearch = true
+  offlineSearch = false
   version_menu = "Releases"
   disableMigrationBanner = true
   releases_url = "/releases.releases"
   global_logo_url = "/"
+  pagefind = true
   version = "Dev"
   [params.ui]
     ul_show = 100
     showLightDarkModeMenu = true
-    breadcrumb_disable = true
+    breadcrumb_disable = false
     sidebar_menu_foldable = true
     sidebar_menu_compact = false
+  [params.ui.feedback]
+    enable = true
+    yes = 'Glad to hear it! Please <a href="https://github.com/googleapis/genai-toolbox/issues/new">tell us how we can improve</a>.'
+    no = 'Sorry to hear that. Please <a href="https://github.com/googleapis/genai-toolbox/issues/new">tell us how we can improve</a>.'
+  [params.ui.readingtime]
+      enable = true
 
 [[params.versions]]
   version = "Dev"
@@ -151,3 +158,7 @@ ignoreFiles = ["quickstart/shared", "quickstart/python", "quickstart/js", "quick
 
 [outputs]
   home = ["HTML", "RSS", "LLMS", "LLMS-FULL", "releases"]
+
+[services]
+  [services.googleAnalytics]
+    id = "G-GLSV9KD8BF"

.hugo/hugo.toml

@@ -35,17 +35,24 @@ ignoreFiles = ["quickstart/shared", "quickstart/python", "quickstart/js", "quick
   github_repo = "https://github.com/googleapis/genai-toolbox"
   github_project_repo = "https://github.com/googleapis/genai-toolbox"
   github_subdir = "docs"
-  offlineSearch = true
+  offlineSearch = false
   version_menu = "Releases"
   releases_url = "/genai-toolbox/releases.releases"
   global_logo_url = "/genai-toolbox/"
   version = "Dev"
+  pagefind = true
   [params.ui]
     ul_show = 100
     showLightDarkModeMenu = true
-    breadcrumb_disable = true
+    breadcrumb_disable = false
     sidebar_menu_foldable = true
     sidebar_menu_compact = false
+  [params.ui.feedback]
+    enable = true
+    yes = 'Glad to hear it! Please <a href="https://github.com/googleapis/genai-toolbox/issues/new">tell us how we can improve</a>.'
+    no = 'Sorry to hear that. Please <a href="https://github.com/googleapis/genai-toolbox/issues/new">tell us how we can improve</a>.'
+  [params.ui.readingtime]
+      enable = true
 
 [[params.versions]]
   version = "Dev"
@@ -173,3 +180,8 @@ ignoreFiles = ["quickstart/shared", "quickstart/python", "quickstart/js", "quick
 
 [outputs]
   home = ["HTML", "RSS", "LLMS", "LLMS-FULL", "releases"]
+
+# Google Analytics ID
+[services]
+  [services.googleAnalytics]
+    id = "G-GLSV9KD8BF"

.hugo/layouts/docs/section.html

@@ -11,8 +11,10 @@ <h1>{{ .Title }}</h1>
     {{ .Content }}
     {{ partial "section-index.html" . }}
     {{ partial "pager.html" . }}
-    {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) }}
-        {{ partial "feedback.html" .Site.Params.ui.feedback }}
+    {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.Config.Services.GoogleAnalytics.ID)) }}
+        <hr class="mt-5 mb-4">
+        <div class="mt-4">
+        {{ partial "feedback.html" . }}
         <br />
     {{ end }}
     {{ if (.Site.Params.DisqusShortname) }}

.hugo/layouts/docs/single.html

@@ -11,8 +11,10 @@ <h1>{{ .Title }}</h1>
     {{ .Content }}
     {{ partial "section-index.html" . }}
     {{ partial "pager.html" . }}
-    {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.GoogleAnalytics)) }}
-        {{ partial "feedback.html" .Site.Params.ui.feedback }}
+    {{ if (and (not .Params.hide_feedback) (.Site.Params.ui.feedback.enable) (.Site.Config.Services.GoogleAnalytics.ID)) }}
+        <hr class="mt-5 mb-4">
+        <div class="mt-4">
+        {{ partial "feedback.html" . }}
         <br />
     {{ end }}
     {{ if (.Site.Params.DisqusShortname) }}