Use "ref" type in sidebar Doc<->Reference cross links (#49)

Fixes #46 See https://docusaurus.io/docs/sidebar/multiple-sidebars#sidebar-item-ref
pantsbuild · Jan 3, 2024 · b9a2d7a · b9a2d7a
1 parent 764d694
commit b9a2d7a
Show file tree

Hide file tree

Showing 21 changed files with 42 additions and 42 deletions.
diff --git a/sidebars.js b/sidebars.js
@@ -7,7 +7,7 @@ const sidebars = {
       className: "margin-vert--none",
     },
     {
-      type: "doc",
+      type: "ref",
       id: "reference/global-options",
       label: "Reference",
     },
@@ -20,7 +20,7 @@ const sidebars = {
       className: "margin-vert--none",
     },
     {
-      type: "doc",
+      type: "ref",
       id: "docs/introduction/how-does-pants-work",
       label: "Docs",
     },

diff --git a/versioned_sidebars/version-2.0-sidebars.json b/versioned_sidebars/version-2.0-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.1-sidebars.json b/versioned_sidebars/version-2.1-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.10-sidebars.json b/versioned_sidebars/version-2.10-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.11-sidebars.json b/versioned_sidebars/version-2.11-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.12-sidebars.json b/versioned_sidebars/version-2.12-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.13-sidebars.json b/versioned_sidebars/version-2.13-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.14-sidebars.json b/versioned_sidebars/version-2.14-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.15-sidebars.json b/versioned_sidebars/version-2.15-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.16-sidebars.json b/versioned_sidebars/version-2.16-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.17-sidebars.json b/versioned_sidebars/version-2.17-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.18-sidebars.json b/versioned_sidebars/version-2.18-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.19-sidebars.json b/versioned_sidebars/version-2.19-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.2-sidebars.json b/versioned_sidebars/version-2.2-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.3-sidebars.json b/versioned_sidebars/version-2.3-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.4-sidebars.json b/versioned_sidebars/version-2.4-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.5-sidebars.json b/versioned_sidebars/version-2.5-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/introduction/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.6-sidebars.json b/versioned_sidebars/version-2.6-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/learn-about-pants/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.7-sidebars.json b/versioned_sidebars/version-2.7-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/learn-about-pants/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.8-sidebars.json b/versioned_sidebars/version-2.8-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/learn-about-pants/welcome-to-pants",
       "label": "Docs"
     }

diff --git a/versioned_sidebars/version-2.9-sidebars.json b/versioned_sidebars/version-2.9-sidebars.json
@@ -10,7 +10,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "reference/global-options",
       "label": "Reference"
     }
@@ -26,7 +26,7 @@
       "className": "margin-vert--none"
     },
     {
-      "type": "doc",
+      "type": "ref",
       "id": "docs/learn-about-pants/welcome-to-pants",
       "label": "Docs"
     }