feat(#478 | docs): setup TypeDoc and integrate with Docusaurus (#508)

Author: hashirpm

docs/.gitignore

@@ -7,6 +7,9 @@
 # Should be generated on build by the plugin
 /static/llms.txt
 
+# Typedoc generated folder
+/docs/api-reference
+
 # Generated files
 .docusaurus
 .cache-loader

docs/docs/api-reference.md

@@ -91,6 +91,45 @@ const config = {
         ],
       },
     ],
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        id: 'api-hypergraph',
+        entryPoints: ['../packages/hypergraph/src/index.ts'],
+        tsconfig: '../packages/hypergraph/tsconfig.json',
+        out: 'docs/api-reference/hypergraph',
+        readme: 'none',
+        name: 'Hypergraph',
+        categorizeByGroup: false,
+        excludeExternals: true,
+        excludePrivate: true,
+        excludeProtected: true,
+        sidebar: {
+          autoConfiguration: true,
+          pretty: true,
+        },
+      },
+    ],
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        id: 'api-hypergraph-react',
+        entryPoints: ['../packages/hypergraph-react/src/index.ts'],
+        tsconfig: '../packages/hypergraph-react/tsconfig.json',
+        out: 'docs/api-reference/hypergraph-react',
+        readme: 'none',
+        name: 'Hypergraph React',
+        categorizeByGroup: false,
+        excludeExternals: true,
+        excludePrivate: true,
+        excludeProtected: true,
+        skipErrorChecking: true,
+        sidebar: {
+          autoConfiguration: true,
+          pretty: true,
+        },
+      },
+    ],
   ],
 
   presets: [

docs/docusaurus.config.js

@@ -25,7 +25,8 @@
   "devDependencies": {
     "@docusaurus/module-type-aliases": "3.8.1",
     "@docusaurus/types": "3.8.1",
-    "docusaurus-plugin-llms": "^0.1.5"
+    "docusaurus-plugin-llms": "^0.1.5",
+    "docusaurus-plugin-typedoc": "^1.4.2"
   },
   "browserslist": {
     "production": [

docs/package.json

@@ -14,6 +14,9 @@
 
  @type {import('@docusaurus/plugin-content-docs').SidebarsConfig}
  */
+import typedocSidebarHypergraph from './docs/api-reference/hypergraph/typedoc-sidebar.cjs';
+import typedocSidebarHypergraphReact from './docs/api-reference/hypergraph-react/typedoc-sidebar.cjs';
+
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
   docs: [
@@ -34,7 +37,24 @@ const sidebars = {
     { type: 'doc', id: 'filtering-query-results', label: '🔍 Filtering Query Results' },
     { type: 'doc', id: 'space-invitations', label: '🔗 Space Invitations' },
     { type: 'doc', id: 'inboxes', label: '🔍 Inboxes' },
-    // { type: 'doc', id: 'api-reference', label: '📚 API Reference' },
+    {
+      type: 'category',
+      label: '📚 API Reference',
+      items: [
+        {
+          type: 'category',
+          label: 'Hypergraph',
+          link: { type: 'doc', id: 'api-reference/hypergraph/index' },
+          items: typedocSidebarHypergraph,
+        },
+        {
+          type: 'category',
+          label: 'Hypergraph React',
+          link: { type: 'doc', id: 'api-reference/hypergraph-react/index' },
+          items: typedocSidebarHypergraphReact,
+        },
+      ],
+    },
     { type: 'doc', id: 'troubleshooting', label: '🛠️ Troubleshooting' },
     { type: 'doc', id: 'faq', label: '❓ FAQ' },
     {