trycua--cua/scripts/docs-generators/config.json

{
  "$schema": "./config.schema.json",
  "description": "Configuration for auto-generating documentation from source code",
  "generators": {
    "cua-driver": {
      "name": "Cua Driver",
      "language": "rust",
      "sourcePath": "libs/cua-driver/rust/crates",
      "docsOutputPath": "docs/content/docs/reference/cua-driver",
      "generatorScript": "scripts/docs-generators/cua-driver.ts",
      "watchPaths": [
        "libs/cua-driver/rust/crates/**/*.rs",
        "libs/cua-driver/rust/Cargo.toml",
        "libs/cua-driver/rust/Cargo.lock"
      ],
      "buildCommand": "cargo build -p cua-driver --release",
      "buildDirectory": "libs/cua-driver/rust",
      "extractionMethod": "dump-docs",
      "outputs": [
        {
          "type": "mcp",
          "outputFile": "mcp-tools.mdx",
          "extractCommand": "target/release/cua-driver dump-docs --type mcp"
        },
        {
          "type": "cli",
          "outputFile": "cli-reference.mdx",
          "extractCommand": "target/release/cua-driver dump-docs --type cli"
        }
      ],
      "enabled": true,
      "notes": "Generates cli-reference.mdx + mcp-tools.mdx from the Rust binary's `dump-docs`. MCP tool docs come straight from the live tool registry; CLI docs come from a hand-maintained `cli_docs_json()` literal in crates/cua-driver/src/cli.rs (the CLI is hand-parsed, not clap, so there is nothing to introspect yet — introspecting it is a tracked follow-up). Curated cross-cutting content lives in the sibling non-generated files mcp-tool-notes.mdx and macos-permissions.mdx."
    },
    "lume": {
      "name": "Lume VM Manager",
      "language": "swift",
      "sourcePath": "libs/lume/src",
      "docsOutputPath": "docs/content/docs/reference/lume",
      "generatorScript": "scripts/docs-generators/lume.ts",
      "watchPaths": [
        "libs/lume/src/Commands/**/*.swift",
        "libs/lume/src/Server/**/*.swift",
        "libs/lume/src/Utils/CommandDocExtractor.swift",
        "libs/lume/src/Server/APIDocExtractor.swift"
      ],
      "buildCommand": "swift build -c release",
      "buildDirectory": "libs/lume",
      "extractionMethod": "dump-docs",
      "outputs": [
        {
          "type": "cli",
          "outputFile": "cli-reference.mdx",
          "extractCommand": ".build/release/lume dump-docs --type cli"
        },
        {
          "type": "api",
          "outputFile": "http-api.mdx",
          "extractCommand": ".build/release/lume dump-docs --type api"
        }
      ],
      "enabled": true,
      "notes": "Generates cli-reference.mdx + http-api.mdx from the Swift binary's `dump-docs` output. These files live under the Diátaxis Reference tree; task-oriented Lume docs belong under how-to-guides/lume."
    },
    "cua-cli": {
      "name": "Cua CLI",
      "language": "typescript",
      "sourcePath": "libs/typescript/cua-cli/src",
      "docsOutputPath": "docs/content/docs/cua/reference/cli-playbook",
      "generatorScript": "scripts/docs-generators/cua-cli.ts",
      "watchPaths": ["libs/typescript/cua-cli/src/**/*.ts"],
      "buildCommand": null,
      "buildDirectory": "libs/typescript/cua-cli",
      "extractionMethod": "yargs-parse",
      "outputs": [
        {
          "type": "cli",
          "outputFile": "commands.mdx",
          "extractCommand": null
        }
      ],
      "enabled": false,
      "notes": "Requires yargs introspection or AST parsing - to be implemented"
    },
    "mcp-server": {
      "name": "MCP Server",
      "language": "python",
      "sourcePath": "libs/python/mcp-server/src",
      "docsOutputPath": "docs/content/docs/cua/reference/mcp-server",
      "generatorScript": "scripts/docs-generators/mcp-server.ts",
      "watchPaths": ["libs/python/mcp-server/src/**/*.py"],
      "buildCommand": null,
      "buildDirectory": "libs/python/mcp-server",
      "extractionMethod": "mcp-introspection",
      "outputs": [
        {
          "type": "tools",
          "outputFile": "tools.mdx",
          "extractCommand": null
        }
      ],
      "enabled": false,
      "notes": "Requires MCP tool introspection - to be implemented"
    },
    "python-sdk": {
      "name": "Python SDKs (Computer + Agent)",
      "language": "python",
      "sourcePath": "libs/python",
      "docsOutputPath": "docs/content/docs/cua/reference",
      "generatorScript": "scripts/docs-generators/python-sdk.ts",
      "watchPaths": ["libs/python/computer/computer/**/*.py", "libs/python/agent/agent/**/*.py"],
      "buildCommand": null,
      "buildDirectory": "libs/python",
      "extractionMethod": "griffe",
      "outputs": [
        {
          "type": "api",
          "outputFile": "computer-sdk/api.mdx",
          "extractCommand": "python3 scripts/docs-generators/extract_python_docs.py"
        },
        {
          "type": "api",
          "outputFile": "agent-sdk/api.mdx",
          "extractCommand": "python3 scripts/docs-generators/extract_python_docs.py"
        }
      ],
      "enabled": false,
      "notes": "Disabled while these SDK docs are not part of the public docs nav; prevents docs:generate from resurrecting the old docs/content/docs/cua/reference tree."
    },
    "computer-sdk-typescript": {
      "name": "Computer SDK (TypeScript)",
      "language": "typescript",
      "sourcePath": "libs/typescript/computer/src",
      "docsOutputPath": "docs/content/docs/cua/reference/computer-sdk",
      "generatorScript": "scripts/docs-generators/typescript-sdk.ts",
      "watchPaths": ["libs/typescript/computer/src/**/*.ts"],
      "extractionMethod": "typedoc",
      "outputs": [
        {
          "type": "api",
          "outputFile": "typescript-api.mdx",
          "extractCommand": null
        }
      ],
      "enabled": false,
      "notes": "Requires TypeDoc or ts-morph introspection - to be implemented"
    },
    "agent-sdk-typescript": {
      "name": "Agent SDK (TypeScript)",
      "language": "typescript",
      "sourcePath": "libs/typescript/agent/src",
      "docsOutputPath": "docs/content/docs/cua/reference/agent-sdk",
      "generatorScript": "scripts/docs-generators/typescript-sdk.ts",
      "watchPaths": ["libs/typescript/agent/src/**/*.ts"],
      "extractionMethod": "typedoc",
      "outputs": [
        {
          "type": "api",
          "outputFile": "typescript-api.mdx",
          "extractCommand": null
        }
      ],
      "enabled": false,
      "notes": "Requires TypeDoc or ts-morph introspection - to be implemented"
    },
    "cuabot": {
      "name": "Cua-Bot",
      "language": "typescript",
      "sourcePath": "libs/cuabot/src",
      "docsOutputPath": "docs/content/docs/cuabot/reference",
      "generatorScript": "scripts/docs-generators/typescript-sdk.ts",
      "watchPaths": ["libs/cuabot/src/**/*.ts"],
      "buildCommand": null,
      "buildDirectory": "libs/cuabot",
      "extractionMethod": "regex-parse",
      "outputs": [
        {
          "type": "api",
          "outputFile": "index.mdx",
          "extractCommand": null
        }
      ],
      "enabled": false,
      "notes": "Disabled while cuabot docs are not part of the public docs nav; prevents docs:generate from resurrecting docs/content/docs/cuabot/reference."
    }
  }
}