docs-kit-mcp/docs.config.js at master · marcuspmd/docs-kit-mcp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
/** @type {import('docs-kit').Config} */
export default {
  // Source directory to scan when running `docs-kit index`
  // Allows you to run `docs-kit index` without passing the path as argument
  rootDir: "src",

  // Output directories for generated content
  output: {
    site: "docs-site",   // used by `docs-kit build-site`
    docs: "my-docs",     // used by `docs-kit build-docs`
  },

  include: [
    "**/*.ts",
    "**/*.tsx",
    "**/*.js",
    "**/*.jsx",
    "**/*.py",
    "**/*.java",
    "**/*.go",
    "**/*.rs",
  ],
  exclude: [
    "**/node_modules/**",
    "**/dist/**",
    "**/build/**",
    "**/out/**",
    "**/.next/**",
    "**/vendor/**",
    "**/__pycache__/**",
    "**/target/**",
    "**/.git/**",
    "**/coverage/**",
    "**/*.min.js",
    "**/*.bundle.js",
    "**/*.map",
    "**/*.d.ts",
    "**/package-lock.json",
    "**/yarn.lock",
    "**/pnpm-lock.yaml",
    '**/__tests__/**',
  ],
  respectGitignore: true,
  maxFileSize: 512_000,
  dbPath: ".docs-kit/index.db",
  promptRules: [],
  coverage: {
    lcovPath: "./coverage/lcov.info",
    enabled: true,
  },
  // RAG (Retrieval-Augmented Generation) Configuration
  // Control when embeddings are created during indexing
  // Useful to disable if you only want LLM for doc generation, not for search
  rag: {
    enabled: false, // Set to false to skip expensive embeddings during index
    chunkSize: 500, // Words per chunk (optional)
    overlapSize: 50, // Overlapping words between chunks (optional)
  },
  // Indexing Configuration
  // Control parallel processing during indexing for faster performance
  indexing: {
    parallel: true, // Enable parallel indexing using worker threads (default: true)
    maxWorkers: undefined, // Max worker threads (default: CPU count - 1, capped at 8)
  },
  // Architecture governance rules (language-specific configuration)
  // archGuard: {
  //   languages: [
  //     {
  //       language: "php",
  //       // Empty rules = apply ALL available PHP rules
  //       // rules: ["php:layer_boundary", "php:naming_class"],
  //       ignorePaths: ["**/legacy/**", "**/vendor/**"],
  //       overrideRules: [
  //         { code: "php:max_complexity", config: { max: 15 } }
  //       ],
  //       excludeRules: ["php:missing_return_type_strict"]
  //     },
  //     {
  //       language: "typescript",
  //       ignorePaths: ["**/*.test.ts", "**/__tests__/**"]
  //     }
  //   ],
  //   customRules: [
  //     {
  //       language: ["php", "typescript"],
  //       code: "custom:no_todo",
  //       description: "No TODO comments",
  //       severity: "warning",
  //       check: (content) => (content.match(/TODO:/g) || []).length
  //     }
  //   ]
  // },

  // llm: {
  //   provider: "ollama",
  //   model: "qwen2.5:3b",
  //   embeddingModel: "nomic-embed-text:latest",
  //   baseUrl: "http://localhost:11434",
  // },
  // To use OpenAI instead, uncomment below and set your .env file:
  // llm: {
  //   provider: "openai",
  //   apiKey: { env: "OPENAI_API_KEY" }, // References .env
  //   model: "gpt-5",
  //   embeddingModel: "text-embedding-ada-002",
  // },
  docs: [
    {
      path: "./docs/README.md",
      title: "Introduction",
      name: "introduction",
      category: "main",
      module: "Main",
      symbols: [],
      next: "docs/domain/arch-guard-rules.md",
      showOnMenu: true,
    },
    {
      path: "./docs/ARCHITECTURE.md",
      title: "Architecture Overview",
      name: "architecture-overview",
      category: "main",
      module: "Main",
      symbols: [],
      showOnMenu: true,
    },
    {
      path: "./docs/domain/arch-guard-rules.md",
      title: "Arch Guard Rules",
      name: "arch-guard-rules",
      category: "domain",
      module: "Main",
      symbols: ["createArchGuard", "ArchGuard", "ArchRule", "ArchViolation"],
      next: "docs/domain/projectStatus.md",
      showOnMenu: true
    },
    {
      path: "./docs/domain/projectStatus.md",
      title: "Project Status",
      name: "project-status",
      category: "domain",
      module: "Main",
      symbols: ["generateProjectStatus", "ProjectStatusResult"],
      previous: "docs/domain/arch-guard-rules.md",
      showOnMenu: true
    },
    {
      path: "./docs/modules/",
      autoDiscovery: true,
      showOnMenu: true
    },
    {
      path: "./docs/examples/",
      autoDiscovery: true,
      showOnMenu: true
    }
  ],

};