Files
docs/doc-weaver/mcp/modules/index.json
Vishesh 'ironeagle' Bangotra 12a2493c6c
Some checks reported errors
continuous-integration/drone/push Build was killed
doc-weaver init and cross wiki-lib links fixes
2026-10-17 23:59:31 +05:30

136 lines
4.1 KiB
JSON

{
"module": "index",
"content": {
"path": "index",
"docstring": "",
"objects": {
"collectModules": {
"name": "collectModules",
"kind": "unknown",
"path": "index.collectModules",
"signature": "collectModules",
"docstring": ""
},
"defaultTsconfigFor": {
"name": "defaultTsconfigFor",
"kind": "unknown",
"path": "index.defaultTsconfigFor",
"signature": "defaultTsconfigFor",
"docstring": ""
},
"DocKind": {
"name": "DocKind",
"kind": "unknown",
"path": "index.DocKind",
"signature": "DocKind",
"docstring": ""
},
"DocModule": {
"name": "DocModule",
"kind": "unknown",
"path": "index.DocModule",
"signature": "DocModule",
"docstring": ""
},
"DocObject": {
"name": "DocObject",
"kind": "unknown",
"path": "index.DocObject",
"signature": "DocObject",
"docstring": ""
},
"DocProject": {
"name": "DocProject",
"kind": "unknown",
"path": "index.DocProject",
"signature": "DocProject",
"docstring": ""
},
"generateHumanDocs": {
"name": "generateHumanDocs",
"kind": "unknown",
"path": "index.generateHumanDocs",
"signature": "generateHumanDocs",
"docstring": ""
},
"generateMcpResources": {
"name": "generateMcpResources",
"kind": "unknown",
"path": "index.generateMcpResources",
"signature": "generateMcpResources",
"docstring": ""
},
"HumanDocsOptions": {
"name": "HumanDocsOptions",
"kind": "unknown",
"path": "index.HumanDocsOptions",
"signature": "HumanDocsOptions",
"docstring": ""
},
"main": {
"name": "main",
"kind": "unknown",
"path": "index.main",
"signature": "main",
"docstring": "# doc-weaver\n\nPublic library surface for doc-weaver, the TypeScript counterpart to\n`doc-forge`. It compiles TypeDoc reflection (built from TypeScript + JSDoc)\ninto two renderers:\n\n- a human-facing TypeDoc site (the MkDocs parallel), and\n- a machine-facing MCP JSON bundle (`index.json`, `nav.json`, `modules/`)\n whose shape is byte-compatible with `doc-forge`.\n\nProgrammatic usage:\n\n import { runTypeDocJson, TypeDocJsonToMCP } from 'doc-weaver';\n const json = await runTypeDocJson({ entryPoints: ['src/index.ts'] });\n const bundle = new TypeDocJsonToMCP(json, 'my-app').transform();"
},
"McpBundle": {
"name": "McpBundle",
"kind": "unknown",
"path": "index.McpBundle",
"signature": "McpBundle",
"docstring": ""
},
"MCPServer": {
"name": "MCPServer",
"kind": "unknown",
"path": "index.MCPServer",
"signature": "MCPServer",
"docstring": ""
},
"RefKind": {
"name": "RefKind",
"kind": "unknown",
"path": "index.RefKind",
"signature": "RefKind",
"docstring": ""
},
"resolveModulePath": {
"name": "resolveModulePath",
"kind": "unknown",
"path": "index.resolveModulePath",
"signature": "resolveModulePath",
"docstring": ""
},
"runTypeDocJson": {
"name": "runTypeDocJson",
"kind": "unknown",
"path": "index.runTypeDocJson",
"signature": "runTypeDocJson",
"docstring": ""
},
"serveMcp": {
"name": "serveMcp",
"kind": "unknown",
"path": "index.serveMcp",
"signature": "serveMcp",
"docstring": ""
},
"TypeDocJsonToMCP": {
"name": "TypeDocJsonToMCP",
"kind": "unknown",
"path": "index.TypeDocJsonToMCP",
"signature": "TypeDocJsonToMCP",
"docstring": ""
},
"TypeDocOptions": {
"name": "TypeDocOptions",
"kind": "unknown",
"path": "index.TypeDocOptions",
"signature": "TypeDocOptions",
"docstring": ""
}
}
}
}