WIP: docs on reactive engine

Author: petyosi

apps/virtuoso.dev/.gitignore

@@ -5,6 +5,7 @@
 /build
 docs/virtuoso-api/*
 docs/virtuoso-message-list-api/*
+docs/virtuoso-reactive-engine-api/*
 
 # Generated files
 .docusaurus

apps/virtuoso.dev/docusaurus.config.ts

@@ -158,6 +158,67 @@ const config: Config = {
         sort: 'kind',
       },
     ],
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        id: '@virtuoso.dev/reactive-engine',
+        sidebar: {
+          autoConfiguration: true,
+          typescript: true,
+          pretty: true,
+        },
+        projectDocuments: ['../../packages/reactive-engine/docs/*.md'],
+        // TypeDoc options
+        entryPoints: ['../../packages/reactive-engine/src/index.ts'],
+        tsconfig: 'tsconfig.reactive-engine.json',
+
+        // Plugin options
+        out: 'docs/virtuoso-reactive-engine-api',
+        plugin: ['typedoc-plugin-no-inherit'],
+
+        excludeExternals: false,
+        excludePrivate: true,
+        excludeInternal: true,
+        useHTMLEncodedBrackets: false,
+
+        categoryOrder: ['Guides', 'API Reference', 'Nodes', 'Hooks', 'Operators', 'Combinators', '*', 'Logging', 'Misc'],
+        groupOrder: ['Functions', 'Variables', 'Interfaces', 'Type Aliases', '*'],
+        sort: 'kind',
+        kindSortOrder: [
+          'Function',
+          'Reference',
+          'Project',
+          'Module',
+          'Namespace',
+          'Enum',
+          'EnumMember',
+          'Class',
+          'Interface',
+          'TypeAlias',
+          'Constructor',
+          'Property',
+          'Variable',
+          'Accessor',
+          'Method',
+          'Parameter',
+          'TypeParameter',
+          'TypeLiteral',
+          'CallSignature',
+          'ConstructorSignature',
+          'IndexSignature',
+          'GetSignature',
+          'SetSignature',
+        ],
+
+        disableSources: true,
+        // allReflectionsHaveOwnDocument: true,
+        hideBreadcrumbs: true,
+        parametersFormat: 'table',
+        watch: true,
+        router: 'module',
+      },
+    ],
+
     [
       '@docusaurus/plugin-client-redirects',
       {
@@ -245,13 +306,19 @@ const config: Config = {
           type: 'docSidebar',
           sidebarId: 'messageListApiSidebar',
           position: 'left',
-          label: 'Virtuoso Message List API',
+          label: 'Message List API',
         },
         {
           type: 'docSidebar',
           sidebarId: 'masonryApiSidebar',
           position: 'left',
-          label: 'Virtuoso Masonry API',
+          label: ' Masonry API',
+        },
+        {
+          type: 'docSidebar',
+          sidebarId: 'reactiveEngineSidebar',
+          position: 'left',
+          label: 'Reactive Engine',
         },
         {
           to: '/pricing',

apps/virtuoso.dev/package.json

@@ -32,6 +32,7 @@
     "@radix-ui/themes": "^3.2.0",
     "@tanstack/react-table": "^8.15.0",
     "@virtuoso.dev/masonry": "*",
+    "@virtuoso.dev/reactive-engine": "*",
     "@virtuoso.dev/message-list": "^1.13.1",
     "@virtuoso.dev/react-monaco-editor": "^0.60.0",
     "clsx": "^2.0.0",

apps/virtuoso.dev/sidebars.ts

@@ -1,5 +1,8 @@
 import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'
+import engineSidebar from './docs/virtuoso-reactive-engine-api/typedoc-sidebar'
+import { SidebarItemConfig } from '@docusaurus/plugin-content-docs/src/sidebars/types.js'
 
+const engineSidebarItems = engineSidebar.items as SidebarItemConfig[]
 /**
  * Creating a sidebar enables you to:
  - create an ordered group of docs
@@ -49,6 +52,27 @@ const sidebars: SidebarsConfig = {
       items: require('./docs/virtuoso-masonry-api/typedoc-sidebar.cjs'),
     },
   ],
+  reactiveEngineSidebar: [
+    {
+      type: 'category',
+      collapsible: false,
+      label: 'Reactive Engine',
+      link: {
+        type: 'doc',
+        id: 'virtuoso-reactive-engine-api/index',
+      },
+      items: [
+        ...engineSidebarItems.slice(0, -1),
+
+        {
+          type: 'doc',
+          // @ts-ignore
+          id: engineSidebarItems.at(-1).items[0].id,
+          label: 'API Reference',
+        },
+      ],
+    },
+  ],
   /*
   messageListApiSidebar: [
     { type: "autogenerated", dirName: "virtuoso-message-list-api" },

apps/virtuoso.dev/tsconfig.reactive-engine.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2023", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["../../packages//reactive-engine/src/index.ts"]
+}