chore: continue API sidebar re-org

Close #24
electron · May 13, 2021 · ac21aa7 · ac21aa7
1 parent 53c017c
commit ac21aa7
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 40 deletions.
diff --git a/scripts/tasks/create-sidebar.js b/scripts/tasks/create-sidebar.js
@@ -5,7 +5,18 @@ const { existsSync } = require('fs');
 const { stringify } = require('json5');
 const globby = require('globby');
 
-const IGNORE_LIST = ['api/locales', 'api/remote', 'api/synopsis'];
+const IGNORE_LIST = [
+  // these are to be removed
+  'api/locales',
+  'api/remote',
+  'api/synopsis',
+  // these need to be moved to guides
+  'api/sandbox-option',
+  'api/frameless-window',
+  // these don't belong to any category yet
+  'api/accelerator',
+  'api/experimental',
+];
 
 /**
  * @typedef Entry

diff --git a/sidebars.js b/sidebars.js
@@ -150,11 +150,13 @@ module.exports = {
         'api/crash-reporter',
         'api/desktop-capturer',
         'api/dialog',
-        'api/dock',
         'api/global-shortcut',
         'api/in-app-purchase',
         'api/ipc-main',
         'api/menu',
+        'api/message-channel-main',
+        'api/message-port-main',
+        'api/native-image',
         'api/native-theme',
         'api/net',
         'api/net-log',
@@ -165,13 +167,14 @@ module.exports = {
         'api/protocol',
         'api/screen',
         'api/session',
+        'api/share-menu',
         'api/shell',
         'api/system-preferences',
         'api/touch-bar',
         'api/tray',
         'api/web-contents',
         'api/web-frame-main',
-      ],
+      ].sort(),
     },
     {
       type: 'category',
@@ -182,8 +185,9 @@ module.exports = {
         'api/crash-reporter',
         'api/desktop-capturer',
         'api/ipc-renderer',
+        'api/native-image',
         'api/web-frame',
-      ],
+      ].sort(),
     },
     {
       type: 'category',
@@ -193,7 +197,42 @@ module.exports = {
         'api/file-object',
         'api/webview-tag',
         'api/window-open',
-      ],
+      ].sort(),
+    },
+    {
+      type: 'category',
+      label: 'Chromium and Node.js',
+      items: [
+        'api/command-line-switches',
+        'api/environment-variables',
+        'api/extensions',
+      ].sort(),
+    },
+    {
+      type: 'category',
+      label: 'Classes',
+      items: [
+        'api/client-request',
+        'api/command-line',
+        'api/cookies',
+        'api/debugger',
+        'api/dock',
+        'api/download-item',
+        'api/incoming-message',
+        'api/menu-item',
+        'api/service-workers',
+        'api/touch-bar-button',
+        'api/touch-bar-color-picker',
+        'api/touch-bar-group',
+        'api/touch-bar-label',
+        'api/touch-bar-other-items-proxy',
+        'api/touch-bar-popover',
+        'api/touch-bar-scrubber',
+        'api/touch-bar-segmented-control',
+        'api/touch-bar-slider',
+        'api/touch-bar-spacer',
+        'api/web-request',
+      ].sort()
     },
     {
       type: 'category',
@@ -262,40 +301,5 @@ module.exports = {
         'api/structures/web-source',
       ],
     },
-    {
-      type: 'category',
-      label: 'Miscellaneous',
-      items: [
-        'api/accelerator',
-        'api/client-request',
-        'api/cookies',
-        'api/debugger',
-        'api/download-item',
-        'api/environment-variables',
-        'api/experimental',
-        'api/extensions',
-        'api/frameless-window',
-        'api/incoming-message',
-        'api/menu-item',
-        'api/message-channel-main',
-        'api/message-port-main',
-        'api/native-image',
-        'api/service-workers',
-        'api/share-menu',
-        'api/touch-bar-button',
-        'api/touch-bar-color-picker',
-        'api/touch-bar-group',
-        'api/touch-bar-label',
-        'api/touch-bar-other-items-proxy',
-        'api/touch-bar-popover',
-        'api/touch-bar-scrubber',
-        'api/touch-bar-segmented-control',
-        'api/touch-bar-slider',
-        'api/touch-bar-spacer',
-        'api/web-request',
-        'api/command-line-switches',
-        'api/command-line',
-      ],
-    },
   ],
 };