refactor: switch to json based docs

- feat: start setting up the plugin for parsing
- feat: start parsing classes
- chore: add actual words
- permalink: http://whatthecommit.com/3d6431a17a3b67e8b1341a2c6e4362f8
- chore: it's working!
- permalink: http://whatthecommit.com/8d8c1f3903766b8ef27575d63115cac6
- feat: update framework json
- fix: fixed rendering custom files with css
- chore: update framework json to exclude externals
- feat: setup parsing sapphire classes and do a lot of link fixing
- refactor: switch to sapphire result
- fix: remove replaceall for Node 14 compat
- fix: actually remove replaceAll
- fix: fixed css extraction regex
- I thought I did this already
- fix: fixed broken link on welcome page
- chore: temporarily disable reporting broken links
- feat: much stuff
- change `classes` to `class` to match DJS
- add `typedef` and `namespace` linking
- fix linking of non-generic types
- update guide urls to match `class` change
- chore: bump deps
- chore: i'll explain when you're older!
- permalink: http://whatthecommit.com/91a07064bb814666919304a00161fc6c
- chore: dope
- permalink: http://whatthecommit.com/bab00ed1aa0abb17cce41f36deea1607
- chore: cleanup types
- feat: add variant to typedefs
- build: make it easier to debug
- fix: partially fix link extraction
- feat(docgen): add renderTypedef()
   - Moved parseSee() from /lib/renderer/renderClass.ts to /lib/renderer/utils.ts
   - Add /lib/renderer/renderTypedef.ts
     Which adds basic functionality in the website with things like title, description and extendedDescription
- chore: sort ts interfaces in docgen output
- chore: update doc types
- refactor: completely refactor how links are resolved
- fix: fixed links for `{@link` tags and propegate change to mdn and djs
- fix: use `replace` instead of `replaceAll`
- feat(docusaurus-discordjs-docgen): add functionality for enum and interface
- style(docusaurus-discordjs-docgen): use Array#flat() for typedef
- feat(docusaurus-discordjs-docgen): add constructor table functionality for classes
- feat(docusaurus-discordjs-docgen): align table content to center
- feat(docusaurus-discordjs-docgen): remove description column if all falsy
- feat(docusaurus-discordjs-docgen): add properties functionality for classes
- ci: add automatic vercel deploys workflow
- chore(docusaurus-typedoc-json-parser): initial commit
- chore(docusaurus-typedoc-json-parser): add doc fetching
- chore(docusaurus-typedoc-json-parser): add sidebar rendering
- fix(deps): update all non-major dependencies
- fix(deps): update dependency typedoc-json-parser to ^5.2.0
- feat(docusaurus-typedoc-json-parser): add basic renderers
- style(docusaurus-typedoc-json-parser): curly brackets and spacing
- style(docusaurus-typedoc-json-parser): template literals
- feat(docusaurus-typedoc-json-parser): add class extends and implements
- feat(docusaurus-typedoc-json-parser): add link parsing for the local project
- chore(docusaurus-typedoc-json-parser): add `start` script to bypass debugger
- feat(docusaurus-typedoc-json-parser): add comment info for classes
- chore: update dev deps
- chore: regen and dedupe lockfile

Author: favna

.github/workflows/automatic-vercel-deploy.yml

@@ -0,0 +1,16 @@
+name: Automatic Vercel Deploys
+
+on:
+  # TODO: Enable pre-merge
+  # schedule:
+  #   - cron: '30 3 * * *'
+  workflow_dispatch:
+
+jobs:
+  AutomaticVercelDeploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger Vercel Deploy
+        run: curl -X POST ${VERCEL_DEPLOY_HOOK_URL}
+        env:
+          VERCEL_DEPLOY_HOOK_URL: ${{ secrets.VERCEL_DEPLOY_HOOK_URL }}

.github/workflows/update-submodules.yml

@@ -14,7 +14,7 @@ build/
 .docusaurus/
 .cache-loader/
 docs/Documentation/
-tsconfig.tsbuildinfo
+*.tsbuildinfo
 
 # misc
 .DS_Store
@@ -32,3 +32,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 *.log
+
+# TODO: Remove later
+dist/

.gitignore

@@ -0,0 +1,17 @@
+{
+	"configurations": [
+		{
+			"type": "pwa-node",
+			"request": "launch",
+			"runtimeArgs": ["run-script", "debug"],
+			"name": "Debug Docgen",
+			"runtimeExecutable": "npm",
+			"skipFiles": ["<node_internals>/**", "node_modules/tslib/**"],
+			"internalConsoleOptions": "openOnSessionStart",
+			"cwd": "${workspaceFolder}/docusaurus-discordjs-docgen",
+			"console": "internalConsole",
+			"outputCapture": "std",
+			"outFiles": ["${workspaceFolder}/docusaurus-discordjs-docgen/dist/**/*.js"]
+		}
+	]
+}

.gitmodules

@@ -294,7 +294,7 @@ If you don't understand something in the documentation, you are experiencing pro
 in the right direction, please don't hesitate to join our official
 [Sapphire Community Server](https://sapphirejs.dev/discord).
 
-[frameworksdocs]: ../Documentation/api-framework/
+[frameworksdocs]: ../Documentation/sapphire-framework/General/welcome
 [djs]: https://discord.js.org/
 [saphfw]: https://github.com/sapphiredev/framework
 [updating-guide]: ../Guide/getting-started/updating-from-v2-to-v3

.vscode/launch.json

@@ -37,6 +37,6 @@ Read [Registering Application Commands outside a Command][register-outside] for
 
 :::
 
-[register-application-commands]: ../../../Documentation/api-framework/classes/Command#registerapplicationcommands
-[command]: ../../../Documentation/api-framework/classes/Command
+[register-application-commands]: ../../../Documentation/sapphire-framework/class/Command#registerapplicationcommands
+[command]: ../../../Documentation/sapphire-framework/class/Command
 [register-outside]: ./advanced/registering-application-commands-outside-a-command

data/framework.json

@@ -94,14 +94,14 @@ registry.addChatInputCommandIds('123456789123456789');
 ```
 
 [addchatinputcommandids]:
-  ../../../../Documentation/api-framework/classes/ApplicationCommandRegistry#addchatinputcommandids
+  ../../../../Documentation/sapphire-framework/class/ApplicationCommandRegistry#addchatinputcommandids
 [addchatinputcommandnames]:
-  ../../../../Documentation/api-framework/classes/ApplicationCommandRegistry#addchatinputcommandnames
+  ../../../../Documentation/sapphire-framework/class/ApplicationCommandRegistry#addchatinputcommandnames
 [addcontextmenucommandnames]:
-  ../../../../Documentation/api-framework/classes/ApplicationCommandRegistry#addcontextmenucommandnames
+  ../../../../Documentation/sapphire-framework/class/ApplicationCommandRegistry#addcontextmenucommandnames
 [addcontextmenucommandids]:
-  ../../../../Documentation/api-framework/classes/ApplicationCommandRegistry#addcontextmenucommandids
+  ../../../../Documentation/sapphire-framework/class/ApplicationCommandRegistry#addcontextmenucommandids
 [idhints]: ../registering-chat-input-commands#idhints
-[rcic]: ../../../../Documentation/api-framework/classes/ApplicationCommandRegistry#registerchatinputcommand
-[rcmc]: ../../../../Documentation/api-framework/classes/ApplicationCommandRegistry#registercontextmenucommand
+[rcic]: ../../../../Documentation/sapphire-framework/class/ApplicationCommandRegistry#registerchatinputcommand
+[rcmc]: ../../../../Documentation/sapphire-framework/class/ApplicationCommandRegistry#registercontextmenucommand
 [registering-outside-command-class]: ./registering-application-commands-outside-a-command.mdx

docs/General/Welcome.mdx

@@ -14,4 +14,4 @@ import { RegisterBehavior } from '@sapphire/framework';
 ApplicationCommandRegistries.setDefaultBehaviorWhenNotIdentical(RegisterBehavior.LogToConsole);
 ```
 
-[application-command-registry]: ../../../../Documentation/api-framework/classes/ApplicationCommandRegistry
+[application-command-registry]: ../../../../Documentation/sapphire-framework/class/ApplicationCommandRegistry