Merge branch 'next' into merge-train/fairies

Author: AztecBot

.github/workflows/docs-typesense.yml

@@ -35,13 +35,41 @@ jobs:
           # ~12k to 48 records) into a loud CI failure.
           MIN_HITS: "5000"
         run: |
-          set -o pipefail
+          set -euo pipefail
+
+          # Derive the version-specific docusaurus_tag values from the docs version
+          # configs and append them to the api-nr start_url's docusaurus_tag array.
+          # Each plugin instance produces a tag of the form `docs-${pluginId}-${versionName}`.
+          # The unversioned tags (participate, root, default) are already in the static
+          # config; this step adds entries for `developer` and `network` which bump on
+          # release. Without this, the api-nr records would lose contextual search
+          # visibility every time mainnet/testnet versions change.
+          extra_tags=$(jq -nc \
+            --slurpfile dev docs/developer_version_config.json \
+            --slurpfile net docs/network_version_config.json \
+            '[
+              ("docs-developer-" + ($dev[0].mainnet // "")),
+              ("docs-developer-" + ($dev[0].testnet // "")),
+              ("docs-network-"   + ($net[0].mainnet // "")),
+              ("docs-network-"   + ($net[0].testnet // ""))
+             ] | map(select(. != "docs-developer-" and . != "docs-network-")) | unique')
+          echo "Derived docusaurus_tag values: $extra_tags"
+
+          config_json=$(jq -c --argjson extra "$extra_tags" '
+            .start_urls |= map(
+              if .selectors_key == "api-nr"
+              then .extra_attributes.docusaurus_tag = ((.extra_attributes.docusaurus_tag // []) + $extra | unique)
+              else .
+              end
+            )
+          ' docs/typesense.config.json)
+
           docker run \
             -e "TYPESENSE_API_KEY=${{ secrets.TYPESENSE_API_KEY }}" \
             -e "TYPESENSE_HOST=${{ secrets.TYPESENSE_HOST }}" \
             -e "TYPESENSE_PORT=443" \
             -e "TYPESENSE_PROTOCOL=https" \
-            -e "CONFIG=$(cat docs/typesense.config.json | jq -r tostring)" \
+            -e "CONFIG=$config_json" \
             typesense/docsearch-scraper:0.11.0 2>&1 | tee scraper.log
 
           nb_hits=$(grep -oE 'Nb hits: *[0-9]+' scraper.log | tail -1 | grep -oE '[0-9]+' || true)

docs/typesense.config.json

@@ -4,7 +4,15 @@
     {
       "url": "https://docs.aztec.network/aztec-nr-api/mainnet/",
       "selectors_key": "api-nr",
-      "page_rank": 2
+      "page_rank": 2,
+      "extra_attributes": {
+        "language": "en",
+        "docusaurus_tag": [
+          "docs-participate-current",
+          "docs-root-current",
+          "default"
+        ]
+      }
     },
     {
       "url": "https://docs.aztec.network/",
@@ -55,6 +63,76 @@
       "url",
       "url_without_anchor",
       "type"
+    ],
+    "field_definitions": [
+      { "name": "anchor", "type": "string", "optional": true },
+      { "name": "content", "type": "string", "optional": true },
+      { "name": "url", "type": "string", "facet": true },
+      {
+        "name": "url_without_anchor",
+        "type": "string",
+        "facet": true,
+        "optional": true
+      },
+      {
+        "name": "version",
+        "type": "string[]",
+        "facet": true,
+        "optional": true
+      },
+      {
+        "name": "hierarchy.lvl0",
+        "type": "string",
+        "facet": true,
+        "optional": true
+      },
+      {
+        "name": "hierarchy.lvl1",
+        "type": "string",
+        "facet": true,
+        "optional": true
+      },
+      {
+        "name": "hierarchy.lvl2",
+        "type": "string",
+        "facet": true,
+        "optional": true
+      },
+      {
+        "name": "hierarchy.lvl3",
+        "type": "string",
+        "facet": true,
+        "optional": true
+      },
+      {
+        "name": "hierarchy.lvl4",
+        "type": "string",
+        "facet": true,
+        "optional": true
+      },
+      {
+        "name": "hierarchy.lvl5",
+        "type": "string",
+        "facet": true,
+        "optional": true
+      },
+      {
+        "name": "hierarchy.lvl6",
+        "type": "string",
+        "facet": true,
+        "optional": true
+      },
+      { "name": "type", "type": "string", "facet": true, "optional": true },
+      {
+        "name": "docusaurus_tag",
+        "type": "string*",
+        "facet": true,
+        "optional": true
+      },
+      { "name": ".*_tag", "type": "string", "facet": true, "optional": true },
+      { "name": "language", "type": "string", "facet": true, "optional": true },
+      { "name": "tags", "type": "string[]", "facet": true, "optional": true },
+      { "name": "item_priority", "type": "int64" }
     ]
   },
   "conversation_id": ["833762294"],