redorder forms sidebar items, collapse all but login by default, and …

…fix incorrect filename for Create items
bitwarden · May 3, 2024 · 4da6151 · 4da6151
1 parent 0b67221
commit 4da6151
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 7 deletions.
diff --git a/client/docs/forms/create/__category__.json → client/docs/forms/create/_category_.json b/client/docs/forms/create/__category__.json → client/docs/forms/create/_category_.json
@@ -1,8 +1,9 @@
 {
+  "collapsed": true,
   "label": "Create",
   "link": {
     "type": "generated-index",
     "description": "Common patterns for account creation forms"
   },
-  "collapsed": false
+  "position": 5
 }
diff --git a/client/docs/forms/identity/_category_.json b/client/docs/forms/identity/_category_.json
@@ -1,8 +1,9 @@
 {
+  "collapsed": true,
   "label": "Identity",
   "link": {
     "type": "generated-index",
     "description": "Common patterns for identity forms"
   },
-  "collapsed": false
+  "position": 2
 }
diff --git a/client/docs/forms/login/_category_.json b/client/docs/forms/login/_category_.json
@@ -1,9 +1,9 @@
 {
+  "collapsed": false,
   "label": "Login",
-  "position": 1,
   "link": {
     "type": "generated-index",
     "description": "Common patterns for login forms"
   },
-  "collapsed": false
+  "position": 1
 }
diff --git a/client/docs/forms/payment/_category_.json b/client/docs/forms/payment/_category_.json
@@ -1,8 +1,9 @@
 {
+  "collapsed": true,
   "label": "Payment",
   "link": {
     "type": "generated-index",
     "description": "Common patterns for payment forms"
   },
-  "collapsed": false
+  "position": 3
 }
diff --git a/client/docs/forms/search/_category_.json b/client/docs/forms/search/_category_.json
@@ -1,8 +1,9 @@
 {
+  "collapsed": true,
   "label": "Search",
   "link": {
     "type": "generated-index",
     "description": "Common patterns for search inputs"
   },
-  "collapsed": false
+  "position": 4
 }
diff --git a/client/docs/forms/update/_category_.json b/client/docs/forms/update/_category_.json
@@ -1,8 +1,9 @@
 {
+  "collapsed": true,
   "label": "Update",
   "link": {
     "type": "generated-index",
     "description": "Common patterns for authentication update forms"
   },
-  "collapsed": false
+  "position": 6
 }
diff --git a/client/docusaurus.config.ts b/client/docusaurus.config.ts
@@ -51,6 +51,10 @@ const config: Config = {
       {
         docs: {
           breadcrumbs: false,
+          // @TODO there is a known issue where docs `routeBasePath` set to "/" breaks 404 pages
+          // https://github.com/facebook/docusaurus/issues/9665
+          // https://github.com/facebook/docusaurus/issues/9688
+
           routeBasePath: "/",
           sidebarPath: require.resolve("./sidebars.js"),
         },