Generate llms.txt using Docsy v0.14.3-44-gc6834296 (#9614)

Author: chalin

.gitmodules

@@ -3,7 +3,7 @@
 	path = themes/docsy
 	url = https://github.com/google/docsy.git
   # cSpell:disable-next-line
-	docsy-pin = v0.14.3-37-g6b1698a3
+	docsy-pin = v0.14.3-44-gc6834296
 	docsy-note = "2024-04-01 Switching to google/docsy.git from cncf/docsy.git since we don't have any CNCF customizations."
 	docsy-reminder = "Ensure that any tag referenced by `docsy-pin` is present in the remote repo (url), otherwise add (push) the tags to the repo."
 [submodule "content-modules/opentelemetry-specification"]

config/_default/hugo.yaml

@@ -1,4 +1,4 @@
-# cSpell:ignore bluesky cicd docsy goldmark linkify netlify wordmark noopener
+# cSpell:ignore bluesky cicd docsy goldmark linkify netlify wordmark noopener llms
 baseURL: https://opentelemetry.io
 title: OpenTelemetry
 disableKinds: [taxonomy]
@@ -109,8 +109,8 @@ cascade:
 
   # Enable redirects for site root (and not locales)
   - outputs:
-      # This must match the equivalent of [outputs.home, redirects]
-      [HTML, markdown, RSS, redirects]
+      # This must match the equivalent of [outputs.home, LLMS, redirects]
+      [HTML, markdown, RSS, LLMS, redirects]
     target:
       kind: home
       sites: { matrix: { languages: [en] } }

layouts/docs/baseof.html

@@ -16,7 +16,15 @@
       {{ partial "navbar.html" . }}
     </header>
     <div class="container-fluid td-outer">
+      {{/*
+        <!--
+        There a bug that causes Hugo to escape the scrollspy attributes.
+        FIXME: Hard coding the scrollspy attributes for now.
+         -->
       <div class="td-main" {{- partialCached "td/scrollspy-attr.txt" . .Section | safeHTMLAttr }}>
+      */ -}}
+      {{ $attr := ` data-bs-spy="scroll" data-bs-target=".td-toc" data-bs-root-margin="0px 0px -10%"` -}}
+      <div class="td-main" {{- $attr | safeHTMLAttr }}>
         <div class="row flex-xl-nowrap">
           <aside class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
             <div id="google_translate_element"></div>

package.json

@@ -33,7 +33,7 @@
     "_install:netlify-cli": "npm list netlify-cli || npm install -O netlify-cli",
     "_list:check:*": "npm run --loglevel=warn | grep -Ee '^\\s*check:[^:]+$' | grep -Ev \"check:all|${CMD_SKIP:-noop}\"",
     "_list:check:for-test-and-fix": "npm -s run _list:check:* | grep -Ev \"collector-sync|i18n\"",
-    "_list:cspell": "grep -Ee '^\\s*\"@?cspell' package.json | awk -F: '{print $1}'  | tr -d '\"'",
+    "_list:cspell": "jq -r '.devDependencies | keys[] | select(. == \"cspell\" or startswith(\"@cspell/\"))' package.json | xargs",
     "_list:diff-never-empty": "echo README.md && npm run _list:diff --",
     "_list:diff:all": "(npm run -s _list:diff -- HEAD; git ls-files --others --exclude-standard) | sort -u",
     "_list:diff": "git diff --name-only --diff-filter=AMR",