From 78300e59bb2df4746d5054c1531f7ff6a9da3e14 Mon Sep 17 00:00:00 2001 From: Jonathan Ho Date: Sat, 9 Dec 2023 05:27:16 -0800 Subject: [PATCH] chore: move architecture to new docs (#3274) * chore: move architecture to new docs * chore: move api reference * chore: faster local build * fix: env --- .gitignore | 16 +++---- typedoc.json | 2 +- .../generated/.nojekyll | 0 .../generated/README.md | 0 .../generated/_category_.json | 0 .../generated/classes/_category_.json | 0 .../generated/enums/_category_.json | 0 .../generated/interfaces/_category_.json | 0 .../generated/modules.md | 0 .../generated/modules/_category_.json | 0 website/{old_docs => docs}/architecture.mdx | 0 website/docusaurus.config.js | 43 ++++++++++++++++++- website/sidebars.js | 1 + website/webpack-docusaurus-plugin.js | 2 +- 14 files changed, 52 insertions(+), 12 deletions(-) rename website/{docs => api_reference}/generated/.nojekyll (100%) rename website/{docs => api_reference}/generated/README.md (100%) rename website/{docs => api_reference}/generated/_category_.json (100%) rename website/{docs => api_reference}/generated/classes/_category_.json (100%) rename website/{docs => api_reference}/generated/enums/_category_.json (100%) rename website/{docs => api_reference}/generated/interfaces/_category_.json (100%) rename website/{docs => api_reference}/generated/modules.md (100%) rename website/{docs => api_reference}/generated/modules/_category_.json (100%) rename website/{old_docs => docs}/architecture.mdx (100%) diff --git a/.gitignore b/.gitignore index d61b00416..b4754b900 100644 --- a/.gitignore +++ b/.gitignore @@ -21,14 +21,14 @@ proxies/*/.yarn/* !proxies/*/.yarn/releases !proxies/*/.yarn/sdks !proxies/*/.yarn/versions -site/docs/generated/classes -site/docs/generated/enums -site/docs/generated/interfaces -site/docs/generated/modules -website/docs/generated/classes/*.md -website/docs/generated/enums/*.md -website/docs/generated/interfaces/*.md -website/docs/generated/modules/*.md +site/api_reference/generated/classes +site/api_reference/generated/enums +site/api_reference/generated/interfaces +site/api_reference/generated/modules +website/api_reference/generated/classes/*.md +website/api_reference/generated/enums/*.md +website/api_reference/generated/interfaces/*.md +website/api_reference/generated/modules/*.md website/.yarn/ # testing coverage diff --git a/typedoc.json b/typedoc.json index 15897ccbf..e8c86087c 100644 --- a/typedoc.json +++ b/typedoc.json @@ -3,7 +3,7 @@ "entryPointStrategy": "packages", "entryPoints": ["packages/bot", "packages/gateway", "packages/rest", "packages/types", "packages/utils"], "skipErrorChecking": true, - "out": "./website/docs/generated/", + "out": "./website/api_reference/generated/", "cleanOutputDir": false, "plugin": ["typedoc-plugin-markdown"], "commentStyle": "all" diff --git a/website/docs/generated/.nojekyll b/website/api_reference/generated/.nojekyll similarity index 100% rename from website/docs/generated/.nojekyll rename to website/api_reference/generated/.nojekyll diff --git a/website/docs/generated/README.md b/website/api_reference/generated/README.md similarity index 100% rename from website/docs/generated/README.md rename to website/api_reference/generated/README.md diff --git a/website/docs/generated/_category_.json b/website/api_reference/generated/_category_.json similarity index 100% rename from website/docs/generated/_category_.json rename to website/api_reference/generated/_category_.json diff --git a/website/docs/generated/classes/_category_.json b/website/api_reference/generated/classes/_category_.json similarity index 100% rename from website/docs/generated/classes/_category_.json rename to website/api_reference/generated/classes/_category_.json diff --git a/website/docs/generated/enums/_category_.json b/website/api_reference/generated/enums/_category_.json similarity index 100% rename from website/docs/generated/enums/_category_.json rename to website/api_reference/generated/enums/_category_.json diff --git a/website/docs/generated/interfaces/_category_.json b/website/api_reference/generated/interfaces/_category_.json similarity index 100% rename from website/docs/generated/interfaces/_category_.json rename to website/api_reference/generated/interfaces/_category_.json diff --git a/website/docs/generated/modules.md b/website/api_reference/generated/modules.md similarity index 100% rename from website/docs/generated/modules.md rename to website/api_reference/generated/modules.md diff --git a/website/docs/generated/modules/_category_.json b/website/api_reference/generated/modules/_category_.json similarity index 100% rename from website/docs/generated/modules/_category_.json rename to website/api_reference/generated/modules/_category_.json diff --git a/website/old_docs/architecture.mdx b/website/docs/architecture.mdx similarity index 100% rename from website/old_docs/architecture.mdx rename to website/docs/architecture.mdx diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 9d75a4bf8..098dfb4f6 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -98,6 +98,13 @@ const config = { label: 'Tutorial', docsPluginId: 'tutorial', }, + { + type: 'docSidebar', + sidebarId: 'api_reference', + position: 'left', + label: 'API Reference', + docsPluginId: 'api_reference', + }, { to: '/blog', label: 'Blog', position: 'left' }, { href: 'https://discord.gg/ddeno', @@ -161,6 +168,27 @@ const config = { }, ], }, + { + title: 'API Reference', + items: [ + { + label: 'Classes', + to: '/api_reference/category/classes-3', + }, + { + label: 'Enums', + to: '/api_reference/category/enums-3', + }, + { + label: 'Interfaces', + to: '/api_reference/category/interfaces-3', + }, + { + label: 'Modules', + to: '/api_reference/category/modules-3', + }, + ], + }, { title: 'Community', items: [ @@ -215,15 +243,26 @@ const config = { editUrl: 'https://github.com/discordeno/discordeno/tree/main/site/', }, ], + [ + '@docusaurus/plugin-content-docs', + /** @type {import('@docusaurus/plugin-content-docs').Options} */ + { + id: 'api_reference', + path: 'api_reference', + routeBasePath: 'api_reference', + sidebarPath: require.resolve('./sidebars.js'), + editUrl: 'https://github.com/discordeno/discordeno/tree/main/site/', + }, + ], [ require.resolve('@easyops-cn/docusaurus-search-local'), { indexDocs: true, indexPages: true, - docsRouteBasePath: ['/docs', '/tutorial'], + docsRouteBasePath: ['/docs', '/tutorial', 'api_reference'], language: ['en'], hashed: true, - docsDir: ['docs', 'tutorial'], + docsDir: ['docs', 'tutorial', 'api_reference'], blogDir: [], removeDefaultStopWordFilter: true, highlightSearchTermsOnTargetPage: true, diff --git a/website/sidebars.js b/website/sidebars.js index a78d57e0b..4b1beb6bf 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -17,6 +17,7 @@ const sidebars = { tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], tutorial: [{ type: 'autogenerated', dirName: '.' }], old_docs: [{ type: 'autogenerated', dirName: '.' }], + api_reference: [{ type: 'autogenerated', dirName: '.' }], // But you can create a sidebar manually /* tutorialSidebar: [ diff --git a/website/webpack-docusaurus-plugin.js b/website/webpack-docusaurus-plugin.js index c23a7c4d7..289485ff7 100644 --- a/website/webpack-docusaurus-plugin.js +++ b/website/webpack-docusaurus-plugin.js @@ -9,7 +9,7 @@ module.exports = function (context, options) { return { name: 'webpack-docusaurus-plugin', configureWebpack(config, isServer, utils) { - const cacheOptions = { cache: false } + const cacheOptions = { cache: process.env.CI !== 'true' } const minimizer = new TerserPlugin({ minify: TerserPlugin.esbuildMinify,