chore: enforce toc when no section top-level content (#376)

mfw78 · web-flow · commit 594d8dda0223 · 2024-04-24T14:29:13.000Z
# Description When there is no content specified in a `README.mdx` / `README.md` within a folder, this creates a "category" in Docusaurus, and, if there is children content, this will just appear as navigation items under the folder's name as a new Section (i.e. there is no TOC, and no specific page for that folder / section when selected). This causes issues, such as when wanting to refer users to "all order types" (see https://docs.cow.fi/category/concepts and try to click 'Order Types'). It's a common request to be asked what order types are supported, and not having a section that contains this in a snapshot makes the documentation difficult to navigate / cumbersome. # Changes - [x] All sections that do not have a `README.mdx` / `README.md` (i.e. no top level content), now have an auto-generated table of contents.
diff --git a/docs/cow-protocol/_category_.json b/docs/cow-protocol/_category_.json
@@ -2,8 +2,5 @@
     "position": 2,
     "label": "🐮 CoW Protocol",
     "collapsible": true,
-    "collapsed": true,
-    "customProps": {
-        "description": "This is the CoW Protocol section."
-    }
+    "collapsed": true
 }
diff --git a/docs/cow-protocol/concepts/_category_.json b/docs/cow-protocol/concepts/_category_.json
@@ -4,10 +4,6 @@
     "collapsible": true,
     "collapsed": true,
     "link": {
-        "type": "generated-index",
-        "title": "Concepts"
-    },
-    "customProps": {
-        "description": "This is the concepts section."
+        "type": "generated-index"
     }
 }
diff --git a/docs/cow-protocol/concepts/benefits/_category_.json b/docs/cow-protocol/concepts/benefits/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 4,
-    "label": "Benefits"
-}
+    "label": "Benefits",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/concepts/how-it-works/_category_.json b/docs/cow-protocol/concepts/how-it-works/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 2,
-    "label": "How it works"
-}
+    "label": "How it works",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/concepts/introduction/_category_.json b/docs/cow-protocol/concepts/introduction/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 1,
-    "label": "Introduction"
-}
+    "label": "Introduction",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/concepts/order-types/_category_.json b/docs/cow-protocol/concepts/order-types/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 3,
-    "label": "Order types"
-}
+    "label": "Order types",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/reference/_category_.json b/docs/cow-protocol/reference/_category_.json
@@ -4,10 +4,6 @@
     "collapsible": true,
     "collapsed": true,
     "link": {
-        "type": "generated-index",
-        "title": "Technical reference"
-    },
-    "customProps": {
-        "description": "This is the technical reference section."
+        "type": "generated-index"
     }
 }
diff --git a/docs/cow-protocol/reference/apis/_category_.json b/docs/cow-protocol/reference/apis/_category_.json
@@ -1,4 +1,9 @@
 {
     "label": "APIs",
-    "position": 6
-}
+    "position": 6,
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/reference/contracts/_category_.json b/docs/cow-protocol/reference/contracts/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 6,
-    "label": "Contracts"
-}
+    "label": "Contracts",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/reference/contracts/core/_category_.json b/docs/cow-protocol/reference/contracts/core/_category_.json
@@ -1,3 +1,3 @@
 {
     "position": 1
-}
+}
diff --git a/docs/cow-protocol/reference/contracts/periphery/_category_.json b/docs/cow-protocol/reference/contracts/periphery/_category_.json
@@ -1,3 +1,3 @@
 {
     "position": 2
-}
+}
diff --git a/docs/cow-protocol/reference/contracts/programmatic/_category_.json b/docs/cow-protocol/reference/contracts/programmatic/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 3,
-    "label": "Programmatic"
-}
+    "label": "Programmatic",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/reference/core/_category_.json b/docs/cow-protocol/reference/core/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 3,
-    "label": "Core"
-}
+    "label": "Core",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/reference/core/auctions/_category_.json b/docs/cow-protocol/reference/core/auctions/_category_.json
@@ -1,3 +1,3 @@
 {
     "position": 2
-}
+}
diff --git a/docs/cow-protocol/reference/periphery/_category_.json b/docs/cow-protocol/reference/periphery/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 4,
-    "label": "Periphery"
-}
+    "label": "Periphery",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/reference/periphery/composable-cow/_category_.json b/docs/cow-protocol/reference/periphery/composable-cow/_category_.json
@@ -1,3 +1,3 @@
 {
     "position": 1
-}
+}
diff --git a/docs/cow-protocol/reference/periphery/hooks/_category_.json b/docs/cow-protocol/reference/periphery/hooks/_category_.json
@@ -1,3 +1,3 @@
 {
     "position": 2
-}
+}
diff --git a/docs/cow-protocol/reference/sdks/_category_.json b/docs/cow-protocol/reference/sdks/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 5,
-    "label": "SDKs"
-}
+    "label": "SDKs",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
+}
diff --git a/docs/cow-protocol/tutorials/_category_.json b/docs/cow-protocol/tutorials/_category_.json
@@ -4,10 +4,6 @@
     "collapsible": true,
     "collapsed": true,
     "link": {
-        "type": "generated-index",
-        "title": "Tutorials"
-    },
-    "customProps": {
-        "description": "This is the tutorials section."
+        "type": "generated-index"
     }
 }
diff --git a/docs/cow-protocol/tutorials/arbitrate/solver/_category_.json b/docs/cow-protocol/tutorials/arbitrate/solver/_category_.json
@@ -1,5 +1,9 @@
 {
     "label": "Solver",
     "collapsible": false,
-    "collapsed": false
+    "collapsed": false,
+    "link": {
+        "type": "generated-index",
+        "title": "Solver"
+    }
 }
diff --git a/docs/governance/_category_.json b/docs/governance/_category_.json
@@ -2,8 +2,5 @@
     "position": 3,
     "label": "🗳️ Governance",
     "collapsible": true,
-    "collapsed": true,
-    "customProps": {
-        "description": "This is the governance section."
-    }
+    "collapsed": true
 }
diff --git a/docs/governance/grants.md b/docs/governance/grants.md
diff --git a/docs/governance/grants/README.mdx b/docs/governance/grants/README.mdx
@@ -4,7 +4,7 @@ sidebar_position: 1
 
 # CoW Grants Program
 
-Aligned with [CoW DAO mission statement](../mission) and vision the CoW Grants Program (CGP) is tasked with funding and supporting the growth of the CoW Protocol ecosystem. To fulfill this mission, CoW DAO allocates funds towards the CoW Grants Program through formal CIPs:
+Aligned with [CoW DAO mission statement](/governance/mission) and vision the CoW Grants Program (CGP) is tasked with funding and supporting the growth of the CoW Protocol ecosystem. To fulfill this mission, CoW DAO allocates funds towards the CoW Grants Program through formal CIPs:
 
 - [CIP-8](https://snapshot.org/#/cow.eth/proposal/0xdc641be107f139753cea051f1bacb8b74b915713a95306c3994f5e03e20d6bef)
 - [CIP-18](https://snapshot.org/#/cow.eth/proposal/0x1b152ae847d003034e84b796ac153ab3549f69891cef49c5d915ee5930c0b256)
diff --git a/docs/governance/grants/application-process.md b/docs/governance/grants/application-process.md
@@ -8,7 +8,7 @@ To apply for the CoW Grants program, use the [application template](application-
 
 ### Public Review
 
-1. Submit your application by completing the [application form template](application-template) and posting it in the [Grants forum section](https://forum.cow.fi/c/cow-grants-program/10). Ensure your application aligns with the [Grants Program](grants-program) guidelines.
+1. Submit your application by completing the [application form template](application-template) and posting it in the [Grants forum section](https://forum.cow.fi/c/cow-grants-program/10). Ensure your application aligns with the [Grants Program](/governance/grants) guidelines.
 2. The Grants Committee will review the application and provide comments on the proposal.
 3. Committee members may express support, objection, or suggest changes to the grant application.
 
diff --git a/docs/governance/process/_category_.json b/docs/governance/process/_category_.json
@@ -1,3 +1,3 @@
 {
     "position": 3
-}
+}
diff --git a/docs/mevblocker/_category_.json b/docs/mevblocker/_category_.json
@@ -2,9 +2,5 @@
     "position": 2,
     "label": "🏖️ MEV Blocker",
     "collapsible": true,
-    "collapsed": true,
-    "customProps": {
-        "description": "This is the MEV Blocker section."
-    }
+    "collapsed": true
 }
-
diff --git a/docs/mevblocker/builders/fees/_category_.json b/docs/mevblocker/builders/fees/_category_.json
@@ -2,5 +2,8 @@
     "position": 2,
     "label": "Fees",
     "collapsible": true,
-    "collapsed": true
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
 }
diff --git a/docs/mevblocker/concepts/_category_.json b/docs/mevblocker/concepts/_category_.json
@@ -4,10 +4,6 @@
     "collapsible": true,
     "collapsed": true,
     "link": {
-        "type": "generated-index",
-        "title": "Concepts"
-    },
-    "customProps": {
-        "description": "This is the concepts section."
+        "type": "generated-index"
     }
 }
diff --git a/docs/mevblocker/concepts/mev-concepts/_category_.json b/docs/mevblocker/concepts/mev-concepts/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 4,
-    "label": "MEV Concepts"
+    "label": "MEV Concepts",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
 }
diff --git a/docs/mevblocker/searchers/_category_.json b/docs/mevblocker/searchers/_category_.json
@@ -4,10 +4,6 @@
     "collapsible": true,
     "collapsed": true,
     "link": {
-        "type": "generated-index",
-        "title": "Searchers"
-    },
-    "customProps": {
-        "description": "This is the Searchers section."
+        "type": "generated-index"
     }
 }
diff --git a/docs/mevblocker/users-and-integrators/_category_.json b/docs/mevblocker/users-and-integrators/_category_.json
@@ -2,5 +2,8 @@
     "position": 4,
     "label": "Users & Integrators",
     "collapsible": true,
-    "collapsed": true
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
 }
diff --git a/docs/mevblocker/users-and-integrators/integrators/_category_.json b/docs/mevblocker/users-and-integrators/integrators/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 2,
-    "label": "Integrators"
+    "label": "Integrators",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
 }
diff --git a/docs/mevblocker/users-and-integrators/users/_category_.json b/docs/mevblocker/users-and-integrators/users/_category_.json
@@ -1,4 +1,9 @@
 {
     "position": 1,
-    "label": "Users"
+    "label": "Users",
+    "collapsible": true,
+    "collapsed": true,
+    "link": {
+        "type": "generated-index"
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,6 @@`
`4`	`4`	`"collapsible": true,`
`5`	`5`	`"collapsed": true,`
`6`	`6`	`"link": {`
`7`		`- "type": "generated-index",`
`8`		`- "title": "Concepts"`
`9`		`- },`
`10`		`- "customProps": {`
`11`		`- "description": "This is the concepts section."`
	`7`	`+ "type": "generated-index"`
`12`	`8`	`}`
`13`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`	`2`	`"position": 1`
`3`		`-}`
	`3`	`+}`