Merge pull request #45 from BetterDiscord/feat/restructure

Restructure Plugin and Theme docs

Author: zerebos

.vitepress/config.ts

@@ -1,5 +1,5 @@
 import {DefaultTheme, defineConfig, UserConfig} from "vitepress";
-import {VitePressSidebarOptions, withSidebar} from "vitepress-sidebar";
+import {withSidebar, generateSidebar} from "vitepress-sidebar";
 import {bundledLanguages, LanguageRegistration} from "shiki";
 import {groupIconMdPlugin, groupIconVitePlugin, localIconLoader} from "vitepress-plugin-group-icons";
 
@@ -41,11 +41,11 @@ const VITEPRESS_CONFIG: UserConfig<DefaultTheme.Config> = {
             {
                 text: "Developer Guides",
                 items: [
-                    {text: "General", link: "/developers/", activeMatch: "/developers/"},
+                    // {text: "General", link: "/developers/", activeMatch: "/developers/"},
                     {text: "Plugins", link: "/plugins/", activeMatch: "/plugins/"},
                     {text: "Themes", link: "/themes/", activeMatch: "/themes/"},
                 ],
-                activeMatch: "/(?:developers|plugins|themes)/"
+                activeMatch: "/(?:plugins|themes)/"
             },
             {
                 text: "Reference",
@@ -94,6 +94,7 @@ const VITEPRESS_CONFIG: UserConfig<DefaultTheme.Config> = {
         outline: "deep",
     },
 
+    // base: "/docs/",
     sitemap: {
         hostname: "https://docs.betterdiscord.app"
     },
@@ -181,7 +182,7 @@ const VITEPRESS_CONFIG: UserConfig<DefaultTheme.Config> = {
 };
 
 
-const SIDEBARS: VitePressSidebarOptions[] = [
+const SIDEBARS: Parameters<typeof generateSidebar>[0] = [
     {
         documentRootPath: "docs",
         scanStartPath: "api",
@@ -191,7 +192,8 @@ const SIDEBARS: VitePressSidebarOptions[] = [
         // useTitleFromFileHeading: true,
         includeRootIndexFile: true,
         capitalizeEachWords: true,
-        collapsed: false,
+        collapsed: true,
+        collapseDepth: 1,
         sortFolderTo: "bottom",
         sortMenusByFrontmatterOrder: true,
         frontmatterOrderDefaultValue: 1,
@@ -226,17 +228,17 @@ const SIDEBARS: VitePressSidebarOptions[] = [
         frontmatterOrderDefaultValue: 1,
         manualSortFileNameByPriority: ["getting-started", "guides"],
     },
-    {
-        documentRootPath: "docs",
-        scanStartPath: "developers",
-        basePath: "/developers/",
-        resolvePath: "/developers/",
-        useTitleFromFileHeading: true,
-        includeRootIndexFile: true,
-        sortFolderTo: "bottom",
-        sortMenusByFrontmatterOrder: true,
-        frontmatterOrderDefaultValue: 1,
-    },
+    // {
+    //     documentRootPath: "docs",
+    //     scanStartPath: "developers",
+    //     basePath: "/developers/",
+    //     resolvePath: "/developers/",
+    //     useTitleFromFileHeading: true,
+    //     includeRootIndexFile: true,
+    //     sortFolderTo: "bottom",
+    //     sortMenusByFrontmatterOrder: true,
+    //     frontmatterOrderDefaultValue: 1,
+    // },
     {
         documentRootPath: "docs",
         scanStartPath: "plugins",
@@ -245,11 +247,15 @@ const SIDEBARS: VitePressSidebarOptions[] = [
         useTitleFromFileHeading: true,
         includeRootIndexFile: true,
         capitalizeEachWords: true,
-        collapsed: false,
+        followSymlinks: true,
+        useFolderTitleFromIndexFile: true,
+        excludeFilesByFrontmatterFieldName: "hide",
+        collapsed: true,
+        collapseDepth: 2,
         sortFolderTo: "bottom",
         sortMenusByFrontmatterOrder: true,
         frontmatterOrderDefaultValue: 1,
-        manualSortFileNameByPriority: ["introduction", "basics", "intermediate", "advanced"],
+        manualSortFileNameByPriority: ["introduction", "tutorials", "ui", "concepts", "publishing"],
     },
     {
         documentRootPath: "docs",
@@ -259,11 +265,14 @@ const SIDEBARS: VitePressSidebarOptions[] = [
         useTitleFromFileHeading: true,
         includeRootIndexFile: true,
         capitalizeEachWords: true,
+        followSymlinks: true,
+        useFolderTitleFromIndexFile: true,
+        excludeFilesByFrontmatterFieldName: "hide",
         collapsed: false,
         sortFolderTo: "bottom",
         sortMenusByFrontmatterOrder: true,
         frontmatterOrderDefaultValue: 1,
-        manualSortFileNameByPriority: ["introduction", "basics", "intermediate", "advanced"],
+        manualSortFileNameByPriority: ["introduction", "tutorials", "concepts", "publishing"],
     },
 ];
 

bun.lock

@@ -12,4 +12,4 @@ Discord uses Webpack as their bundler and through [`BdApi.Webpack`](/api/classes
 
 ## Data Stores
 
-This common type of modules holds data that is used throughout the entire app by Discord. This includes local caches of information about users, guilds, roles, or anything else that may otherwise need to be pulled from the server. Having access to these can greatly enhance any plugin you may be working on. You can take a look at a mostly comprehensive list on the next page, or you can check out the [plugin guide](/plugins/advanced/webpack.md) for a walkthrough and tips on reverse engineering individual methods.
+This common type of modules holds data that is used throughout the entire app by Discord. This includes local caches of information about users, guilds, roles, or anything else that may otherwise need to be pulled from the server. Having access to these can greatly enhance any plugin you may be working on. You can take a look at a mostly comprehensive list on the next page, or you can check out the [plugin guide](../../plugins/concepts/webpack.md) for a walkthrough and tips on reverse engineering individual methods.