Fix sidebars and other minor tweaks

Author: ejscribner

docusaurus/docs/advanced/how-ottoman-works.md

@@ -134,7 +134,7 @@ const AirportModel = model(
   });
 ```
 
-### Ottoman vs SDK Connection
+### Ottoman vs. SDK Connection
 
 Create our Ottoman instance and connect:
 

docusaurus/docs/advanced/sdk-comparison.md

@@ -1,4 +1,4 @@
-# Ottoman Vs SDK Comparison
+# Ottoman vs. SDK Comparison
 
 This document outlines subtle differences between Ottoman and Node.js SDK
 and also demonstrate the value proposition (advantages) that Ottoman brings over Node.js SDK.

docusaurus/docusaurus.config.js

@@ -118,6 +118,22 @@ const config = {
         entryPoints: ['../src/index.ts'],
         tsconfig: '../tsconfig.json',
         exclude: '**/node_modules/**',
+        readme: 'none',
+      },
+    ],
+    [
+      '@docusaurus/plugin-client-redirects',
+      {
+        redirects: [
+          {
+            from: '/docs/api/enums/SearchConsistency',
+            to: '/docs/api/enumerations/SearchConsistency',
+          },
+          {
+            from: '/docs/api/enums/VALIDATION_STRATEGY',
+            to: '/docs/api/enumerations/VALIDATION_STRATEGY',
+          },
+        ],
       },
     ],
   ],

docusaurus/package.json

@@ -16,6 +16,7 @@
   },
   "dependencies": {
     "@docusaurus/core": "3.8.1",
+    "@docusaurus/plugin-client-redirects": "^3.8.1",
     "@docusaurus/preset-classic": "3.8.1",
     "@mdx-js/react": "^3.1.0",
     "clsx": "^2.1.1",

docusaurus/sidebars.js

@@ -14,20 +14,41 @@
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
-
-  // But you can create a sidebar manually
-  /*
   tutorialSidebar: [
     'intro',
-    'hello',
+    'quick-start',
+    {
+      type: 'category',
+      label: 'Basic',
+      items: ['basic/schema', 'basic/model', 'basic/document', 'basic/ottoman', 'basic/query-builder'],
+    },
+    {
+      type: 'category',
+      label: 'Advanced',
+      items: [
+        'advanced/fts',
+        'advanced/transactions',
+        'advanced/how-ottoman-works',
+        'advanced/ottoman',
+        'advanced/mongoose-to-couchbase',
+        'advanced/ottoman-couchbase',
+        'advanced/ottomanV1-to-ottomanV2',
+        'advanced/sdk-comparison',
+      ],
+    },
+    'first-app',
+    'cli/cli',
     {
       type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
+      label: 'API',
+      link: {
+        type: 'doc',
+        id: 'api/index',
+      },
+      items: require('./docs/api/typedoc-sidebar.cjs'),
     },
+    'faq',
   ],
-   */
 };
 
 module.exports = sidebars;

docusaurus/static/_redirects

@@ -0,0 +1,2 @@
+/docs/api/enums/SearchConsistency /docs/api/enumerations/SearchConsistency 301
+/docs/api/enums/VALIDATION_STRATEGY /docs/api/enumerations/VALIDATION_STRATEGY 301

docusaurus/yarn.lock

@@ -1703,6 +1703,21 @@
     react-helmet-async "npm:@slorber/react-helmet-async@1.3.0"
     react-loadable "npm:@docusaurus/react-loadable@6.0.0"
 
+"@docusaurus/plugin-client-redirects@^3.8.1":
+  version "3.8.1"
+  resolved "https://registry.yarnpkg.com/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-3.8.1.tgz#1d02b3565ae4e53a3b8005835501f07fb0bc0267"
+  integrity sha512-F+86R7PBn6VNgy/Ux8w3ZRypJGJEzksbejQKlbTC8u6uhBUhfdXWkDp6qdOisIoW0buY5nLqucvZt1zNJzhJhA==
+  dependencies:
+    "@docusaurus/core" "3.8.1"
+    "@docusaurus/logger" "3.8.1"
+    "@docusaurus/utils" "3.8.1"
+    "@docusaurus/utils-common" "3.8.1"
+    "@docusaurus/utils-validation" "3.8.1"
+    eta "^2.2.0"
+    fs-extra "^11.1.1"
+    lodash "^4.17.21"
+    tslib "^2.6.0"
+
 "@docusaurus/plugin-content-blog@3.8.1":
   version "3.8.1"
   resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.8.1.tgz#88d842b562b04cf59df900d9f6984b086f821525"