refactor: further improving and cleaning up typedocs config

Author: axe312ger

package.json

@@ -38,7 +38,7 @@
     "clean": "rimraf dist",
     "build": "npm run clean && NODE_ENV=production rollup -c",
     "build:types": "rimraf dist/typings && tsc --declaration --noEmit false --emitDeclarationOnly true --allowJs false",
-    "docs:build": "typedoc --options typedoc.json",
+    "docs:build": "typedoc",
     "docs:dev": "npm run docs:build -- --watch",
     "docs:publish": "npm run build:docs && ./node_modules/contentful-sdk-jsdoc/bin/publish-docs.sh contentful-management.js contentful-management",
     "lint": "eslint lib test",
@@ -74,10 +74,7 @@
     "axios": "^1.12.2",
     "contentful-sdk-core": "^9.2.1",
     "fast-copy": "^3.0.0",
-    "globals": "^15.15.0",
-    "typedoc-github-theme": "^0.2.1",
-    "typedoc-plugin-markdown": "^4.4.2",
-    "typedoc-plugin-missing-exports": "^3.1.0"
+    "globals": "^15.15.0"
   },
   "devDependencies": {
     "@contentful/integration-test-utils": "^2.0.1",
@@ -116,7 +113,9 @@
     "semantic-release": "^25.0.2",
     "size-limit": "^11.1.6",
     "type-fest": "^4.18.3",
-    "typedoc": "^0.27.9",
+    "typedoc": "^0.28.1",
+    "typedoc-github-theme": "^0.2.1",
+    "typedoc-plugin-missing-exports": "^3.1.0",
     "typescript": "^5.6.3",
     "typescript-eslint": "^8.16.0",
     "vitest": "^2.1.5"

typedoc.json

@@ -2,28 +2,55 @@
   "name": "contentful-management.js",
   "entryPoints": [
     "lib/contentful-management.ts",
-    "lib/plain/plain-client.ts",
-    "lib/plain/wrappers/wrap.ts",
-    "lib/contentful-management.ts",
-    "lib/create-adapter.ts",
-    "lib/create-contentful-api.ts",
-    "lib/entities/app-action.ts",
-    "lib/entities/environment-template-installation.ts"
+    // "lib/plain/plain-client.ts",
+    // "lib/plain/wrappers/wrap.ts",
+    // "lib/contentful-management.ts",
+    // "lib/create-adapter.ts",
+    // "lib/create-contentful-api.ts",
+    // "lib/entities/app-action.ts",
+    // "lib/entities/environment-template-installation.ts"
   ],
   "out": "out",
   "includeVersion": true,
-  "categorizeByGroup": true,
-  "categoryOrder": ["Core", "Clients", "Entities", "Utilities", "*"],
+  // "categorizeByGroup": true,
+  // "categoryOrder": ["Core", "Clients", "Entities", "Utilities", "*"],
+  "categoryOrder": ["createClient", "ClientParams", "ContentType", "Entry", "*"],
+  // "groupOrder": ["Variables", "Functions", "*"],
+  "kindSortOrder": [
+    "Reference",
+    "Project",
+    "Module",
+    "Namespace",
+    "Constructor",
+    "Property",
+    "Function",
+    "Enum",
+    "EnumMember",
+    "Class",
+    "Interface",
+    "TypeAlias",
+    "Variable",
+    "Accessor",
+    "Method",
+    "Parameter",
+    "TypeParameter",
+    "TypeLiteral",
+    "CallSignature",
+    "ConstructorSignature",
+    "IndexSignature",
+    "GetSignature",
+    "SetSignature"
+  ],
+  "sortEntryPoints": false,
   "readme": "README.md",
   "excludePrivate": false,
   "excludeInternal": false,
   "excludeProtected": false,
-  "treatWarningsAsErrors": true,
+  "treatWarningsAsErrors": false,
   "sort": ["source-order"],
   "plugin": [
     "typedoc-plugin-missing-exports",
     "typedoc-github-theme"
-    //"typedoc-plugin-markdown"
   ],
-  "theme": "typedoc-github-theme"
-}
+  "hideGenerator": true,
+}