chore: update TypeDoc configuration and enhance documentation with new categories and modules

Author: lposen

another-md.md

@@ -0,0 +1,11 @@
+---
+title: External Markdown
+group: Documents
+category: Guides
+children:
+    - ./most-used-modules.md
+---
+
+# HELLO!
+
+I'm an md with some `info`

expand-nav.js

@@ -0,0 +1,91 @@
+// Expand all navigation folders on page load
+(function () {
+  'use strict';
+
+  function expandAllNavigation() {
+    // Find all details elements in various navigation contexts
+    const selectors = [
+      '.tsd-navigation details',
+      '#tsd-nav-container details',
+      '.site-menu details',
+      '.tsd-accordion',
+      'nav details',
+    ];
+
+    let foundAny = false;
+    selectors.forEach((selector) => {
+      const elements = document.querySelectorAll(selector);
+      if (elements.length > 0) {
+        foundAny = true;
+        elements.forEach((el) => {
+          if (el.tagName === 'DETAILS') {
+            el.open = true;
+          }
+        });
+      }
+    });
+
+    return foundAny;
+  }
+
+  // Strategy 1: Try immediately
+  expandAllNavigation();
+
+  // Strategy 2: Hook into TypeDoc's app if available
+  let checkCount = 0;
+  const maxChecks = 50; // Check for up to 5 seconds
+
+  function checkAndExpand() {
+    checkCount++;
+
+    if (expandAllNavigation()) {
+      // Keep expanding even if found, in case more navigation loads
+      if (checkCount < maxChecks) {
+        setTimeout(checkAndExpand, 100);
+      }
+    } else if (checkCount < maxChecks) {
+      setTimeout(checkAndExpand, 100);
+    }
+  }
+
+  // Strategy 3: MutationObserver for dynamic content
+  // eslint-disable-next-line no-undef
+  const observer = new MutationObserver(() => {
+    expandAllNavigation();
+  });
+
+  // Strategy 4: Multiple event listeners
+  window.addEventListener('load', () => {
+    expandAllNavigation();
+    checkAndExpand();
+
+    // Start observing after page load
+    const navContainer = document.querySelector(
+      '#tsd-nav-container, .site-menu'
+    );
+    if (navContainer) {
+      observer.observe(navContainer, {
+        childList: true,
+        subtree: true,
+      });
+    }
+  });
+
+  // Strategy 5: Check for TypeDoc's app initialization
+  if (window.app) {
+    expandAllNavigation();
+  } else {
+    Object.defineProperty(window, 'app', {
+      configurable: true,
+      set: function (value) {
+        delete window.app;
+        window.app = value;
+        setTimeout(expandAllNavigation, 100);
+        setTimeout(expandAllNavigation, 500);
+      },
+      get: function () {
+        return window._app;
+      },
+    });
+  }
+})();

most-used-modules.md

@@ -1,3 +1,4 @@
+
 # Most Used Modules
 
 The modules you are most likely to use are as follows:

package.json

@@ -77,6 +77,7 @@
     "@docusaurus/preset-classic": "^3.9.2",
     "@docusaurus/tsconfig": "^3.9.2",
     "@docusaurus/types": "^3.9.2",
+    "@droppedcode/typedoc-plugin-relative-includes": "^1.0.5",
     "@evilmartians/lefthook": "^1.5.0",
     "@mdx-js/react": "^3.1.1",
     "@react-native/babel-preset": "0.79.3",
@@ -85,6 +86,7 @@
     "@react-native/typescript-config": "0.79.3",
     "@react-navigation/native": "^7.1.14",
     "@release-it/conventional-changelog": "^9.0.4",
+    "@reside-ic/typedoc-plugin-copy-doc": "^1.1.2",
     "@testing-library/jest-native": "^5.4.3",
     "@testing-library/react-native": "^13.3.3",
     "@types/jest": "^29.5.5",
@@ -115,9 +117,13 @@
     "release-it": "^17.10.0",
     "turbo": "^1.10.7",
     "typedoc": "^0.28.13",
+    "typedoc-github-theme": "^0.3.1",
+    "typedoc-material-theme": "^1.4.0",
     "typedoc-plugin-coverage": "^4.0.2",
     "typedoc-plugin-dt-links": "^2.0.24",
+    "typedoc-plugin-emojify": "^1.0.1",
     "typedoc-plugin-inline-sources": "^1.3.0",
+    "typedoc-plugin-localization": "^3.0.6",
     "typedoc-plugin-mermaid": "^1.12.0",
     "typescript": "^5.2.2"
   },

src/core/classes/Iterable.ts

@@ -33,6 +33,10 @@ const RNEventEmitter = new NativeEventEmitter(RNIterableAPI);
  * static methods of this class.  EG: initializing the SDK, logging in a user,
  * tracking purchases, etc.
  *
+ * @document ../../../most-used-modules.md
+ *
+ * @category Testing
+ *
  * @example
  * // Initialize the SDK
  * Iterable.initialize(YOUR_API_KEY, new IterableConfig());
@@ -47,6 +51,8 @@ export class Iterable {
   /**
    * Current configuration of the Iterable SDK
    *
+   * @categoryDescription Advanced Use
+   *
    * @readonly
    */
   static savedConfig: Readonly<IterableConfig> = new IterableConfig();

src/inbox/components/IterableInbox.tsx

@@ -165,6 +165,9 @@ export interface IterableInboxProps
  * It handles fetching messages, displaying them in a list, and showing individual message details.
  * It also manages the state of the inbox, including loading state, selected message, and visible message impressions.
  *
+ * @category React Components
+ * @group React Components
+ *
  * @example
  * ```tsx
  * const [visible, setVisible] = useState<boolean>(false);

tsdoc.json

@@ -1,25 +1,15 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["typedoc/tsdoc.json"],
+  "noStandardTags": false,
   "tagDefinitions": [
     {
       "tagName": "@os",
       "syntaxKind": "block"
     },
-    {
-      "tagName": "@includeCode",
-      "syntaxKind": "inline"
-    },
     {
       "tagName": "@mermaid",
       "syntaxKind": "block"
-    },
-    {
-      "tagName": "@license",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@since",
-      "syntaxKind": "block"
     }
   ]
 }

typedoc.config.mjs

@@ -2,30 +2,65 @@
 /** @type { import('typedoc').TypeDocOptionMap & import('typedoc-umlclass').Config } */
 const config = {
   entryPoints: ['./src/index.tsx'],
-  projectDocuments: ['README.md', 'most-used-modules.md'],
+  projectDocuments: ['README.md', 'most-used-modules.md', 'another-md.md'],
   out: './docs-gen',
   tsconfig: './tsconfig.json',
   excludeInternal: true,
   excludePrivate: true,
-  excludeExternals: true,
+  excludeExternals: false,
   excludePrivateClassFields: true,
   categorizeByGroup: true,
+  excludeProtected: true,
   validation: {
+    notExported: true,
     invalidLink: true,
+    rewrittenLink: true,
     notDocumented: true,
-    notExported: true,
     unusedMergeModuleWith: true,
   },
+  entryPointStrategy: 'expand',
   includeVersion: true,
   searchInComments: true,
   searchInDocuments: true,
-  favicon: './assets/favicon.ico',
   treatValidationWarningsAsErrors: true,
   useFirstParagraphOfCommentAsSummary: true,
+  disableSources: false,
   cascadedModifierTags: ['@beta'],
-  jsDocCompatibility: {
-    inheritDocTag: true,
+  theme: 'typedoc-github-theme',
+  router: 'structure',
+  customFooterHtml: '<p>Copyright <strong>Iterable</strong> 2025</p>',
+  customFooterHtmlDisableWrapper: true,
+  markdownLinkExternal: true,
+  hideGenerator: true,
+  // groupReferencesByType: true,
+  sortEntryPoints: true,
+  sidebarLinks: {
+    Iterable: 'https://app.iterable.com/',
+    Support:
+      'https://support.iterable.com/hc/en-us/articles/360045714072-Overview-of-Iterable-s-React-Native-SDK',
+    Installation:
+      'https://support.iterable.com/hc/en-us/articles/360045714132-Installing-Iterable-s-React-Native-SDK',
   },
+  headings: {
+    readme: true,
+    document: false,
+  },
+  groupOrder: [
+    'Documents',
+    'React Components',
+    'Classes',
+    'Enums',
+    'Interfaces',
+    'Types',
+    'Functions',
+    'Variables',
+    'Constants',
+    '*',
+  ],
+  categoryOrder: ['Documents', 'React Components', '*'],
+  // jsDocCompatibility: {
+  //   inheritDocTag: true,
+  // },
   preservedTypeAnnotationTags: ['@fires', '@license'],
   // transformTags: true,
   requiredToBeDocumented: [
@@ -64,14 +99,26 @@ const config = {
   ],
   navigation: {
     includeCategories: false,
-    includeGroups: false,
+    includeGroups: true,
     compactFolders: false,
     excludeReferences: false,
-    includeFolders: false,
+    includeFolders: true,
+  },
+  alwaysCreateEntryPointModule: false,
+  navigationLinks: {
+    Github: 'https://github.com/Iterable/react-native-sdk',
+    Changelog:
+      'https://github.com/Iterable/react-native-sdk/blob/master/CHANGELOG.md',
+  },
+  searchCategoryBoosts: {
+    'React Components': 1.5,
+  },
+  searchGroupBoosts: {
+    'React Components': 1.5,
   },
   visibilityFilters: {
-    'protected': true,
-    'private': true,
+    'protected': false,
+    'private': false,
     'inherited': true,
     'external': true,
     '@alpha': true,
@@ -111,14 +158,23 @@ const config = {
     // used by {@link react!Component}
     'react': {
       Component: 'https://react.dev/reference/react/Component',
+      FunctionComponent:
+        'https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/mdx/types.d.ts',
     },
   },
   readme: './README.md',
+  customJs: './expand-nav.js',
   plugin: [
     'typedoc-plugin-coverage',
     'typedoc-plugin-mermaid',
     'typedoc-plugin-inline-sources',
     'typedoc-plugin-dt-links',
+    // 'typedoc-plugin-localization',
+    'typedoc-plugin-emojify',
+    '@reside-ic/typedoc-plugin-copy-doc',
+    'typedoc-github-theme',
+    // 'typedoc-material-theme',
+    // '@droppedcode/typedoc-plugin-relative-includes',
   ],
 };