@agentskit/doc-bridge 1.0.2 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +50 -0
- package/CONTRIBUTING.md +8 -0
- package/README.md +114 -17
- package/SECURITY.md +1 -1
- package/action.yml +23 -26
- package/dist/cli/program.js +1241 -309
- package/dist/cli/program.js.map +1 -1
- package/dist/config/index.d.ts +1 -1
- package/dist/config/index.js +338 -13
- package/dist/config/index.js.map +1 -1
- package/dist/{index-CPUJbTbg.d.ts → index-DGI9TBLE.d.ts} +906 -11
- package/dist/index.d.ts +65 -11
- package/dist/index.js +1084 -171
- package/dist/index.js.map +1 -1
- package/docs/DOGFOOD-ROUND2.md +5 -0
- package/docs/DOGFOOD-ROUND3.md +5 -0
- package/docs/DOGFOOD-V1.md +5 -0
- package/docs/DOGFOOD.md +5 -0
- package/docs/MARKETPLACE-ECOSYSTEM-PLAN.md +16 -0
- package/docs/MARKETPLACE.md +39 -0
- package/docs/POSITIONING.md +5 -0
- package/docs/RELEASE.md +26 -19
- package/docs/agent-corpus/INDEX.md +10 -0
- package/docs/agent-corpus/OVERVIEW.md +9 -0
- package/docs/agent-corpus/chat.md +10 -0
- package/docs/agent-corpus/cli.md +10 -0
- package/docs/agent-corpus/conformance.md +10 -0
- package/docs/agent-corpus/doc-bridge.md +10 -0
- package/docs/agent-corpus/doctor.md +10 -0
- package/docs/agent-corpus/gates.md +10 -0
- package/docs/agent-corpus/mcp.md +10 -0
- package/docs/agent-corpus/memory.md +10 -0
- package/docs/agent-corpus/query.md +10 -0
- package/docs/chat-and-rag.md +34 -0
- package/docs/examples.md +5 -0
- package/docs/for-agents.md +31 -0
- package/docs/getting-started.md +32 -2
- package/docs/index.md +23 -0
- package/docs/landing/assets/doc-bridge-hero.webp +0 -0
- package/docs/landing/assets/doc-bridge-surfaces.webp +0 -0
- package/docs/landing/assets/doc-bridge-two-way.webp +0 -0
- package/docs/landing/index.html +70 -10
- package/docs/mcp.md +5 -0
- package/docs/meta.json +20 -0
- package/docs/ollama-demo.md +6 -1
- package/docs/playbook/doc-bridge-pattern.md +4 -2
- package/docs/query.md +34 -0
- package/docs/recipes/index-pipeline.md +7 -2
- package/docs/schemas/agent-handoff-v1.md +5 -0
- package/docs/schemas/doc-bridge-index-v1.md +5 -0
- package/docs/schemas/memory-candidate-v1.md +15 -1
- package/docs/skills/doc-bridge.md +6 -1
- package/docs/spec/cli.md +6 -0
- package/docs/spec/config-v1.md +56 -6
- package/docs/spec/documentation-standard-v1.md +136 -0
- package/docs/spec/playbook-feedback.md +5 -0
- package/docs/spec/registry-agents.md +5 -0
- package/ecosystem-claims.json +187 -0
- package/ecosystem-upstream.json +9 -0
- package/ecosystem.json +235 -0
- package/examples/verify-handoff.mjs +5 -0
- package/package.json +46 -4
- package/scripts/check-ecosystem-upstream.mjs +50 -0
- package/src/cli/program.ts +36 -3
- package/src/config/index.ts +7 -1
- package/src/config/load-config.ts +4 -14
- package/src/config/schema.ts +91 -0
- package/src/conformance/documentation-standard-v1.ts +502 -0
- package/src/conformance/ecosystem-contract.ts +175 -0
- package/src/gates/run-gates.ts +33 -4
- package/src/index-builder/human-adapters/core.ts +12 -5
- package/src/index-builder/human-adapters/docusaurus.ts +29 -44
- package/src/index-builder/human-adapters/index.ts +15 -3
- package/src/index-builder/scan-corpus.ts +6 -6
- package/src/index.ts +17 -0
- package/src/lib/bounded-text.ts +25 -0
- package/src/lib/paths.ts +20 -2
- package/src/lib/static-js-literal.ts +261 -0
- package/src/lib/walk.ts +23 -4
- package/src/version.ts +1 -1
|
@@ -44,6 +44,532 @@ declare const HumanCorpusConfigSchema: z.ZodObject<{
|
|
|
44
44
|
plugin: "plain-markdown" | "fumadocs" | "docusaurus" | "mkdocs" | "vitepress" | "custom";
|
|
45
45
|
options?: Record<string, unknown> | undefined;
|
|
46
46
|
}>;
|
|
47
|
+
declare const EcosystemContractEvidenceSchema: z.ZodObject<{
|
|
48
|
+
manifest: z.ZodString;
|
|
49
|
+
claims: z.ZodString;
|
|
50
|
+
productId: z.ZodString;
|
|
51
|
+
}, "strict", z.ZodTypeAny, {
|
|
52
|
+
manifest: string;
|
|
53
|
+
claims: string;
|
|
54
|
+
productId: string;
|
|
55
|
+
}, {
|
|
56
|
+
manifest: string;
|
|
57
|
+
claims: string;
|
|
58
|
+
productId: string;
|
|
59
|
+
}>;
|
|
60
|
+
declare const DocumentationStandardRuleIdSchema: z.ZodEnum<["human-docs", "llms-and-raw-source", "agent-handoffs", "contribution", "metadata", "cross-links", "tested-quickstarts", "visual-explanations", "structured-diagrams"]>;
|
|
61
|
+
declare const DocumentationStandardV1ConfigSchema: z.ZodEffects<z.ZodObject<{
|
|
62
|
+
rawSources: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
63
|
+
contributionPaths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
64
|
+
metadata: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
65
|
+
path: z.ZodString;
|
|
66
|
+
contains: z.ZodArray<z.ZodString, "many">;
|
|
67
|
+
}, "strict", z.ZodTypeAny, {
|
|
68
|
+
path: string;
|
|
69
|
+
contains: string[];
|
|
70
|
+
}, {
|
|
71
|
+
path: string;
|
|
72
|
+
contains: string[];
|
|
73
|
+
}>, "many">>;
|
|
74
|
+
links: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
75
|
+
url: z.ZodString;
|
|
76
|
+
paths: z.ZodArray<z.ZodString, "many">;
|
|
77
|
+
}, "strict", z.ZodTypeAny, {
|
|
78
|
+
paths: string[];
|
|
79
|
+
url: string;
|
|
80
|
+
}, {
|
|
81
|
+
paths: string[];
|
|
82
|
+
url: string;
|
|
83
|
+
}>, "many">>;
|
|
84
|
+
quickstarts: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
85
|
+
id: z.ZodString;
|
|
86
|
+
doc: z.ZodString;
|
|
87
|
+
test: z.ZodString;
|
|
88
|
+
command: z.ZodString;
|
|
89
|
+
testContains: z.ZodArray<z.ZodString, "many">;
|
|
90
|
+
}, "strict", z.ZodTypeAny, {
|
|
91
|
+
id: string;
|
|
92
|
+
doc: string;
|
|
93
|
+
test: string;
|
|
94
|
+
command: string;
|
|
95
|
+
testContains: string[];
|
|
96
|
+
}, {
|
|
97
|
+
id: string;
|
|
98
|
+
doc: string;
|
|
99
|
+
test: string;
|
|
100
|
+
command: string;
|
|
101
|
+
testContains: string[];
|
|
102
|
+
}>, "many">>;
|
|
103
|
+
visuals: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
104
|
+
diagrams: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
105
|
+
path: z.ZodString;
|
|
106
|
+
contains: z.ZodArray<z.ZodString, "many">;
|
|
107
|
+
}, "strict", z.ZodTypeAny, {
|
|
108
|
+
path: string;
|
|
109
|
+
contains: string[];
|
|
110
|
+
}, {
|
|
111
|
+
path: string;
|
|
112
|
+
contains: string[];
|
|
113
|
+
}>, "many">>;
|
|
114
|
+
ecosystemContract: z.ZodOptional<z.ZodObject<{
|
|
115
|
+
manifest: z.ZodString;
|
|
116
|
+
claims: z.ZodString;
|
|
117
|
+
productId: z.ZodString;
|
|
118
|
+
}, "strict", z.ZodTypeAny, {
|
|
119
|
+
manifest: string;
|
|
120
|
+
claims: string;
|
|
121
|
+
productId: string;
|
|
122
|
+
}, {
|
|
123
|
+
manifest: string;
|
|
124
|
+
claims: string;
|
|
125
|
+
productId: string;
|
|
126
|
+
}>>;
|
|
127
|
+
exceptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
128
|
+
ruleId: z.ZodEnum<["human-docs", "llms-and-raw-source", "agent-handoffs", "contribution", "metadata", "cross-links", "tested-quickstarts", "visual-explanations", "structured-diagrams"]>;
|
|
129
|
+
reason: z.ZodString;
|
|
130
|
+
approvedBy: z.ZodString;
|
|
131
|
+
trackingUrl: z.ZodString;
|
|
132
|
+
}, "strict", z.ZodTypeAny, {
|
|
133
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
134
|
+
reason: string;
|
|
135
|
+
approvedBy: string;
|
|
136
|
+
trackingUrl: string;
|
|
137
|
+
}, {
|
|
138
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
139
|
+
reason: string;
|
|
140
|
+
approvedBy: string;
|
|
141
|
+
trackingUrl: string;
|
|
142
|
+
}>, "many">>;
|
|
143
|
+
}, "strict", z.ZodTypeAny, {
|
|
144
|
+
metadata?: {
|
|
145
|
+
path: string;
|
|
146
|
+
contains: string[];
|
|
147
|
+
}[] | undefined;
|
|
148
|
+
rawSources?: string[] | undefined;
|
|
149
|
+
contributionPaths?: string[] | undefined;
|
|
150
|
+
links?: {
|
|
151
|
+
paths: string[];
|
|
152
|
+
url: string;
|
|
153
|
+
}[] | undefined;
|
|
154
|
+
quickstarts?: {
|
|
155
|
+
id: string;
|
|
156
|
+
doc: string;
|
|
157
|
+
test: string;
|
|
158
|
+
command: string;
|
|
159
|
+
testContains: string[];
|
|
160
|
+
}[] | undefined;
|
|
161
|
+
visuals?: string[] | undefined;
|
|
162
|
+
diagrams?: {
|
|
163
|
+
path: string;
|
|
164
|
+
contains: string[];
|
|
165
|
+
}[] | undefined;
|
|
166
|
+
ecosystemContract?: {
|
|
167
|
+
manifest: string;
|
|
168
|
+
claims: string;
|
|
169
|
+
productId: string;
|
|
170
|
+
} | undefined;
|
|
171
|
+
exceptions?: {
|
|
172
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
173
|
+
reason: string;
|
|
174
|
+
approvedBy: string;
|
|
175
|
+
trackingUrl: string;
|
|
176
|
+
}[] | undefined;
|
|
177
|
+
}, {
|
|
178
|
+
metadata?: {
|
|
179
|
+
path: string;
|
|
180
|
+
contains: string[];
|
|
181
|
+
}[] | undefined;
|
|
182
|
+
rawSources?: string[] | undefined;
|
|
183
|
+
contributionPaths?: string[] | undefined;
|
|
184
|
+
links?: {
|
|
185
|
+
paths: string[];
|
|
186
|
+
url: string;
|
|
187
|
+
}[] | undefined;
|
|
188
|
+
quickstarts?: {
|
|
189
|
+
id: string;
|
|
190
|
+
doc: string;
|
|
191
|
+
test: string;
|
|
192
|
+
command: string;
|
|
193
|
+
testContains: string[];
|
|
194
|
+
}[] | undefined;
|
|
195
|
+
visuals?: string[] | undefined;
|
|
196
|
+
diagrams?: {
|
|
197
|
+
path: string;
|
|
198
|
+
contains: string[];
|
|
199
|
+
}[] | undefined;
|
|
200
|
+
ecosystemContract?: {
|
|
201
|
+
manifest: string;
|
|
202
|
+
claims: string;
|
|
203
|
+
productId: string;
|
|
204
|
+
} | undefined;
|
|
205
|
+
exceptions?: {
|
|
206
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
207
|
+
reason: string;
|
|
208
|
+
approvedBy: string;
|
|
209
|
+
trackingUrl: string;
|
|
210
|
+
}[] | undefined;
|
|
211
|
+
}>, {
|
|
212
|
+
metadata?: {
|
|
213
|
+
path: string;
|
|
214
|
+
contains: string[];
|
|
215
|
+
}[] | undefined;
|
|
216
|
+
rawSources?: string[] | undefined;
|
|
217
|
+
contributionPaths?: string[] | undefined;
|
|
218
|
+
links?: {
|
|
219
|
+
paths: string[];
|
|
220
|
+
url: string;
|
|
221
|
+
}[] | undefined;
|
|
222
|
+
quickstarts?: {
|
|
223
|
+
id: string;
|
|
224
|
+
doc: string;
|
|
225
|
+
test: string;
|
|
226
|
+
command: string;
|
|
227
|
+
testContains: string[];
|
|
228
|
+
}[] | undefined;
|
|
229
|
+
visuals?: string[] | undefined;
|
|
230
|
+
diagrams?: {
|
|
231
|
+
path: string;
|
|
232
|
+
contains: string[];
|
|
233
|
+
}[] | undefined;
|
|
234
|
+
ecosystemContract?: {
|
|
235
|
+
manifest: string;
|
|
236
|
+
claims: string;
|
|
237
|
+
productId: string;
|
|
238
|
+
} | undefined;
|
|
239
|
+
exceptions?: {
|
|
240
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
241
|
+
reason: string;
|
|
242
|
+
approvedBy: string;
|
|
243
|
+
trackingUrl: string;
|
|
244
|
+
}[] | undefined;
|
|
245
|
+
}, {
|
|
246
|
+
metadata?: {
|
|
247
|
+
path: string;
|
|
248
|
+
contains: string[];
|
|
249
|
+
}[] | undefined;
|
|
250
|
+
rawSources?: string[] | undefined;
|
|
251
|
+
contributionPaths?: string[] | undefined;
|
|
252
|
+
links?: {
|
|
253
|
+
paths: string[];
|
|
254
|
+
url: string;
|
|
255
|
+
}[] | undefined;
|
|
256
|
+
quickstarts?: {
|
|
257
|
+
id: string;
|
|
258
|
+
doc: string;
|
|
259
|
+
test: string;
|
|
260
|
+
command: string;
|
|
261
|
+
testContains: string[];
|
|
262
|
+
}[] | undefined;
|
|
263
|
+
visuals?: string[] | undefined;
|
|
264
|
+
diagrams?: {
|
|
265
|
+
path: string;
|
|
266
|
+
contains: string[];
|
|
267
|
+
}[] | undefined;
|
|
268
|
+
ecosystemContract?: {
|
|
269
|
+
manifest: string;
|
|
270
|
+
claims: string;
|
|
271
|
+
productId: string;
|
|
272
|
+
} | undefined;
|
|
273
|
+
exceptions?: {
|
|
274
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
275
|
+
reason: string;
|
|
276
|
+
approvedBy: string;
|
|
277
|
+
trackingUrl: string;
|
|
278
|
+
}[] | undefined;
|
|
279
|
+
}>;
|
|
280
|
+
declare const ConformanceConfigSchema: z.ZodObject<{
|
|
281
|
+
documentationStandardV1: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
282
|
+
rawSources: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
283
|
+
contributionPaths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
284
|
+
metadata: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
285
|
+
path: z.ZodString;
|
|
286
|
+
contains: z.ZodArray<z.ZodString, "many">;
|
|
287
|
+
}, "strict", z.ZodTypeAny, {
|
|
288
|
+
path: string;
|
|
289
|
+
contains: string[];
|
|
290
|
+
}, {
|
|
291
|
+
path: string;
|
|
292
|
+
contains: string[];
|
|
293
|
+
}>, "many">>;
|
|
294
|
+
links: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
295
|
+
url: z.ZodString;
|
|
296
|
+
paths: z.ZodArray<z.ZodString, "many">;
|
|
297
|
+
}, "strict", z.ZodTypeAny, {
|
|
298
|
+
paths: string[];
|
|
299
|
+
url: string;
|
|
300
|
+
}, {
|
|
301
|
+
paths: string[];
|
|
302
|
+
url: string;
|
|
303
|
+
}>, "many">>;
|
|
304
|
+
quickstarts: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
305
|
+
id: z.ZodString;
|
|
306
|
+
doc: z.ZodString;
|
|
307
|
+
test: z.ZodString;
|
|
308
|
+
command: z.ZodString;
|
|
309
|
+
testContains: z.ZodArray<z.ZodString, "many">;
|
|
310
|
+
}, "strict", z.ZodTypeAny, {
|
|
311
|
+
id: string;
|
|
312
|
+
doc: string;
|
|
313
|
+
test: string;
|
|
314
|
+
command: string;
|
|
315
|
+
testContains: string[];
|
|
316
|
+
}, {
|
|
317
|
+
id: string;
|
|
318
|
+
doc: string;
|
|
319
|
+
test: string;
|
|
320
|
+
command: string;
|
|
321
|
+
testContains: string[];
|
|
322
|
+
}>, "many">>;
|
|
323
|
+
visuals: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
324
|
+
diagrams: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
325
|
+
path: z.ZodString;
|
|
326
|
+
contains: z.ZodArray<z.ZodString, "many">;
|
|
327
|
+
}, "strict", z.ZodTypeAny, {
|
|
328
|
+
path: string;
|
|
329
|
+
contains: string[];
|
|
330
|
+
}, {
|
|
331
|
+
path: string;
|
|
332
|
+
contains: string[];
|
|
333
|
+
}>, "many">>;
|
|
334
|
+
ecosystemContract: z.ZodOptional<z.ZodObject<{
|
|
335
|
+
manifest: z.ZodString;
|
|
336
|
+
claims: z.ZodString;
|
|
337
|
+
productId: z.ZodString;
|
|
338
|
+
}, "strict", z.ZodTypeAny, {
|
|
339
|
+
manifest: string;
|
|
340
|
+
claims: string;
|
|
341
|
+
productId: string;
|
|
342
|
+
}, {
|
|
343
|
+
manifest: string;
|
|
344
|
+
claims: string;
|
|
345
|
+
productId: string;
|
|
346
|
+
}>>;
|
|
347
|
+
exceptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
348
|
+
ruleId: z.ZodEnum<["human-docs", "llms-and-raw-source", "agent-handoffs", "contribution", "metadata", "cross-links", "tested-quickstarts", "visual-explanations", "structured-diagrams"]>;
|
|
349
|
+
reason: z.ZodString;
|
|
350
|
+
approvedBy: z.ZodString;
|
|
351
|
+
trackingUrl: z.ZodString;
|
|
352
|
+
}, "strict", z.ZodTypeAny, {
|
|
353
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
354
|
+
reason: string;
|
|
355
|
+
approvedBy: string;
|
|
356
|
+
trackingUrl: string;
|
|
357
|
+
}, {
|
|
358
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
359
|
+
reason: string;
|
|
360
|
+
approvedBy: string;
|
|
361
|
+
trackingUrl: string;
|
|
362
|
+
}>, "many">>;
|
|
363
|
+
}, "strict", z.ZodTypeAny, {
|
|
364
|
+
metadata?: {
|
|
365
|
+
path: string;
|
|
366
|
+
contains: string[];
|
|
367
|
+
}[] | undefined;
|
|
368
|
+
rawSources?: string[] | undefined;
|
|
369
|
+
contributionPaths?: string[] | undefined;
|
|
370
|
+
links?: {
|
|
371
|
+
paths: string[];
|
|
372
|
+
url: string;
|
|
373
|
+
}[] | undefined;
|
|
374
|
+
quickstarts?: {
|
|
375
|
+
id: string;
|
|
376
|
+
doc: string;
|
|
377
|
+
test: string;
|
|
378
|
+
command: string;
|
|
379
|
+
testContains: string[];
|
|
380
|
+
}[] | undefined;
|
|
381
|
+
visuals?: string[] | undefined;
|
|
382
|
+
diagrams?: {
|
|
383
|
+
path: string;
|
|
384
|
+
contains: string[];
|
|
385
|
+
}[] | undefined;
|
|
386
|
+
ecosystemContract?: {
|
|
387
|
+
manifest: string;
|
|
388
|
+
claims: string;
|
|
389
|
+
productId: string;
|
|
390
|
+
} | undefined;
|
|
391
|
+
exceptions?: {
|
|
392
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
393
|
+
reason: string;
|
|
394
|
+
approvedBy: string;
|
|
395
|
+
trackingUrl: string;
|
|
396
|
+
}[] | undefined;
|
|
397
|
+
}, {
|
|
398
|
+
metadata?: {
|
|
399
|
+
path: string;
|
|
400
|
+
contains: string[];
|
|
401
|
+
}[] | undefined;
|
|
402
|
+
rawSources?: string[] | undefined;
|
|
403
|
+
contributionPaths?: string[] | undefined;
|
|
404
|
+
links?: {
|
|
405
|
+
paths: string[];
|
|
406
|
+
url: string;
|
|
407
|
+
}[] | undefined;
|
|
408
|
+
quickstarts?: {
|
|
409
|
+
id: string;
|
|
410
|
+
doc: string;
|
|
411
|
+
test: string;
|
|
412
|
+
command: string;
|
|
413
|
+
testContains: string[];
|
|
414
|
+
}[] | undefined;
|
|
415
|
+
visuals?: string[] | undefined;
|
|
416
|
+
diagrams?: {
|
|
417
|
+
path: string;
|
|
418
|
+
contains: string[];
|
|
419
|
+
}[] | undefined;
|
|
420
|
+
ecosystemContract?: {
|
|
421
|
+
manifest: string;
|
|
422
|
+
claims: string;
|
|
423
|
+
productId: string;
|
|
424
|
+
} | undefined;
|
|
425
|
+
exceptions?: {
|
|
426
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
427
|
+
reason: string;
|
|
428
|
+
approvedBy: string;
|
|
429
|
+
trackingUrl: string;
|
|
430
|
+
}[] | undefined;
|
|
431
|
+
}>, {
|
|
432
|
+
metadata?: {
|
|
433
|
+
path: string;
|
|
434
|
+
contains: string[];
|
|
435
|
+
}[] | undefined;
|
|
436
|
+
rawSources?: string[] | undefined;
|
|
437
|
+
contributionPaths?: string[] | undefined;
|
|
438
|
+
links?: {
|
|
439
|
+
paths: string[];
|
|
440
|
+
url: string;
|
|
441
|
+
}[] | undefined;
|
|
442
|
+
quickstarts?: {
|
|
443
|
+
id: string;
|
|
444
|
+
doc: string;
|
|
445
|
+
test: string;
|
|
446
|
+
command: string;
|
|
447
|
+
testContains: string[];
|
|
448
|
+
}[] | undefined;
|
|
449
|
+
visuals?: string[] | undefined;
|
|
450
|
+
diagrams?: {
|
|
451
|
+
path: string;
|
|
452
|
+
contains: string[];
|
|
453
|
+
}[] | undefined;
|
|
454
|
+
ecosystemContract?: {
|
|
455
|
+
manifest: string;
|
|
456
|
+
claims: string;
|
|
457
|
+
productId: string;
|
|
458
|
+
} | undefined;
|
|
459
|
+
exceptions?: {
|
|
460
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
461
|
+
reason: string;
|
|
462
|
+
approvedBy: string;
|
|
463
|
+
trackingUrl: string;
|
|
464
|
+
}[] | undefined;
|
|
465
|
+
}, {
|
|
466
|
+
metadata?: {
|
|
467
|
+
path: string;
|
|
468
|
+
contains: string[];
|
|
469
|
+
}[] | undefined;
|
|
470
|
+
rawSources?: string[] | undefined;
|
|
471
|
+
contributionPaths?: string[] | undefined;
|
|
472
|
+
links?: {
|
|
473
|
+
paths: string[];
|
|
474
|
+
url: string;
|
|
475
|
+
}[] | undefined;
|
|
476
|
+
quickstarts?: {
|
|
477
|
+
id: string;
|
|
478
|
+
doc: string;
|
|
479
|
+
test: string;
|
|
480
|
+
command: string;
|
|
481
|
+
testContains: string[];
|
|
482
|
+
}[] | undefined;
|
|
483
|
+
visuals?: string[] | undefined;
|
|
484
|
+
diagrams?: {
|
|
485
|
+
path: string;
|
|
486
|
+
contains: string[];
|
|
487
|
+
}[] | undefined;
|
|
488
|
+
ecosystemContract?: {
|
|
489
|
+
manifest: string;
|
|
490
|
+
claims: string;
|
|
491
|
+
productId: string;
|
|
492
|
+
} | undefined;
|
|
493
|
+
exceptions?: {
|
|
494
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
495
|
+
reason: string;
|
|
496
|
+
approvedBy: string;
|
|
497
|
+
trackingUrl: string;
|
|
498
|
+
}[] | undefined;
|
|
499
|
+
}>>;
|
|
500
|
+
}, "strict", z.ZodTypeAny, {
|
|
501
|
+
documentationStandardV1?: {
|
|
502
|
+
metadata?: {
|
|
503
|
+
path: string;
|
|
504
|
+
contains: string[];
|
|
505
|
+
}[] | undefined;
|
|
506
|
+
rawSources?: string[] | undefined;
|
|
507
|
+
contributionPaths?: string[] | undefined;
|
|
508
|
+
links?: {
|
|
509
|
+
paths: string[];
|
|
510
|
+
url: string;
|
|
511
|
+
}[] | undefined;
|
|
512
|
+
quickstarts?: {
|
|
513
|
+
id: string;
|
|
514
|
+
doc: string;
|
|
515
|
+
test: string;
|
|
516
|
+
command: string;
|
|
517
|
+
testContains: string[];
|
|
518
|
+
}[] | undefined;
|
|
519
|
+
visuals?: string[] | undefined;
|
|
520
|
+
diagrams?: {
|
|
521
|
+
path: string;
|
|
522
|
+
contains: string[];
|
|
523
|
+
}[] | undefined;
|
|
524
|
+
ecosystemContract?: {
|
|
525
|
+
manifest: string;
|
|
526
|
+
claims: string;
|
|
527
|
+
productId: string;
|
|
528
|
+
} | undefined;
|
|
529
|
+
exceptions?: {
|
|
530
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
531
|
+
reason: string;
|
|
532
|
+
approvedBy: string;
|
|
533
|
+
trackingUrl: string;
|
|
534
|
+
}[] | undefined;
|
|
535
|
+
} | undefined;
|
|
536
|
+
}, {
|
|
537
|
+
documentationStandardV1?: {
|
|
538
|
+
metadata?: {
|
|
539
|
+
path: string;
|
|
540
|
+
contains: string[];
|
|
541
|
+
}[] | undefined;
|
|
542
|
+
rawSources?: string[] | undefined;
|
|
543
|
+
contributionPaths?: string[] | undefined;
|
|
544
|
+
links?: {
|
|
545
|
+
paths: string[];
|
|
546
|
+
url: string;
|
|
547
|
+
}[] | undefined;
|
|
548
|
+
quickstarts?: {
|
|
549
|
+
id: string;
|
|
550
|
+
doc: string;
|
|
551
|
+
test: string;
|
|
552
|
+
command: string;
|
|
553
|
+
testContains: string[];
|
|
554
|
+
}[] | undefined;
|
|
555
|
+
visuals?: string[] | undefined;
|
|
556
|
+
diagrams?: {
|
|
557
|
+
path: string;
|
|
558
|
+
contains: string[];
|
|
559
|
+
}[] | undefined;
|
|
560
|
+
ecosystemContract?: {
|
|
561
|
+
manifest: string;
|
|
562
|
+
claims: string;
|
|
563
|
+
productId: string;
|
|
564
|
+
} | undefined;
|
|
565
|
+
exceptions?: {
|
|
566
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
567
|
+
reason: string;
|
|
568
|
+
approvedBy: string;
|
|
569
|
+
trackingUrl: string;
|
|
570
|
+
}[] | undefined;
|
|
571
|
+
} | undefined;
|
|
572
|
+
}>;
|
|
47
573
|
declare const DocBridgeConfigV1Schema: z.ZodObject<{
|
|
48
574
|
schemaVersion: z.ZodLiteral<1>;
|
|
49
575
|
project: z.ZodOptional<z.ZodObject<{
|
|
@@ -361,18 +887,18 @@ declare const DocBridgeConfigV1Schema: z.ZodObject<{
|
|
|
361
887
|
gates: z.ZodOptional<z.ZodObject<{
|
|
362
888
|
/** minimal: freshness · standard: + human links · strict: + okf-type · playbook: freshness + okf soft style */
|
|
363
889
|
preset: z.ZodOptional<z.ZodEnum<["minimal", "standard", "strict", "playbook"]>>;
|
|
364
|
-
include: z.ZodOptional<z.ZodArray<z.ZodEnum<["index-freshness", "human-guide-links", "link-rot", "okf-type", "docs-style", "routing-currency", "bootstrap-size"]>, "many">>;
|
|
365
|
-
exclude: z.ZodOptional<z.ZodArray<z.ZodEnum<["index-freshness", "human-guide-links", "link-rot", "okf-type", "docs-style", "routing-currency", "bootstrap-size"]>, "many">>;
|
|
890
|
+
include: z.ZodOptional<z.ZodArray<z.ZodEnum<["index-freshness", "human-guide-links", "link-rot", "okf-type", "docs-style", "routing-currency", "bootstrap-size", "documentation-standard-v1"]>, "many">>;
|
|
891
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodEnum<["index-freshness", "human-guide-links", "link-rot", "okf-type", "docs-style", "routing-currency", "bootstrap-size", "documentation-standard-v1"]>, "many">>;
|
|
366
892
|
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
367
893
|
}, "strict", z.ZodTypeAny, {
|
|
368
894
|
options?: Record<string, unknown> | undefined;
|
|
369
|
-
include?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size")[] | undefined;
|
|
370
|
-
exclude?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size")[] | undefined;
|
|
895
|
+
include?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size" | "documentation-standard-v1")[] | undefined;
|
|
896
|
+
exclude?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size" | "documentation-standard-v1")[] | undefined;
|
|
371
897
|
preset?: "strict" | "minimal" | "standard" | "playbook" | undefined;
|
|
372
898
|
}, {
|
|
373
899
|
options?: Record<string, unknown> | undefined;
|
|
374
|
-
include?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size")[] | undefined;
|
|
375
|
-
exclude?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size")[] | undefined;
|
|
900
|
+
include?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size" | "documentation-standard-v1")[] | undefined;
|
|
901
|
+
exclude?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size" | "documentation-standard-v1")[] | undefined;
|
|
376
902
|
preset?: "strict" | "minimal" | "standard" | "playbook" | undefined;
|
|
377
903
|
}>>;
|
|
378
904
|
surfaces: z.ZodOptional<z.ZodObject<{
|
|
@@ -649,6 +1175,299 @@ declare const DocBridgeConfigV1Schema: z.ZodObject<{
|
|
|
649
1175
|
includeInChat?: boolean | undefined;
|
|
650
1176
|
}[] | undefined;
|
|
651
1177
|
}>>;
|
|
1178
|
+
conformance: z.ZodOptional<z.ZodObject<{
|
|
1179
|
+
documentationStandardV1: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
1180
|
+
rawSources: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
1181
|
+
contributionPaths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
1182
|
+
metadata: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1183
|
+
path: z.ZodString;
|
|
1184
|
+
contains: z.ZodArray<z.ZodString, "many">;
|
|
1185
|
+
}, "strict", z.ZodTypeAny, {
|
|
1186
|
+
path: string;
|
|
1187
|
+
contains: string[];
|
|
1188
|
+
}, {
|
|
1189
|
+
path: string;
|
|
1190
|
+
contains: string[];
|
|
1191
|
+
}>, "many">>;
|
|
1192
|
+
links: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1193
|
+
url: z.ZodString;
|
|
1194
|
+
paths: z.ZodArray<z.ZodString, "many">;
|
|
1195
|
+
}, "strict", z.ZodTypeAny, {
|
|
1196
|
+
paths: string[];
|
|
1197
|
+
url: string;
|
|
1198
|
+
}, {
|
|
1199
|
+
paths: string[];
|
|
1200
|
+
url: string;
|
|
1201
|
+
}>, "many">>;
|
|
1202
|
+
quickstarts: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1203
|
+
id: z.ZodString;
|
|
1204
|
+
doc: z.ZodString;
|
|
1205
|
+
test: z.ZodString;
|
|
1206
|
+
command: z.ZodString;
|
|
1207
|
+
testContains: z.ZodArray<z.ZodString, "many">;
|
|
1208
|
+
}, "strict", z.ZodTypeAny, {
|
|
1209
|
+
id: string;
|
|
1210
|
+
doc: string;
|
|
1211
|
+
test: string;
|
|
1212
|
+
command: string;
|
|
1213
|
+
testContains: string[];
|
|
1214
|
+
}, {
|
|
1215
|
+
id: string;
|
|
1216
|
+
doc: string;
|
|
1217
|
+
test: string;
|
|
1218
|
+
command: string;
|
|
1219
|
+
testContains: string[];
|
|
1220
|
+
}>, "many">>;
|
|
1221
|
+
visuals: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
1222
|
+
diagrams: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1223
|
+
path: z.ZodString;
|
|
1224
|
+
contains: z.ZodArray<z.ZodString, "many">;
|
|
1225
|
+
}, "strict", z.ZodTypeAny, {
|
|
1226
|
+
path: string;
|
|
1227
|
+
contains: string[];
|
|
1228
|
+
}, {
|
|
1229
|
+
path: string;
|
|
1230
|
+
contains: string[];
|
|
1231
|
+
}>, "many">>;
|
|
1232
|
+
ecosystemContract: z.ZodOptional<z.ZodObject<{
|
|
1233
|
+
manifest: z.ZodString;
|
|
1234
|
+
claims: z.ZodString;
|
|
1235
|
+
productId: z.ZodString;
|
|
1236
|
+
}, "strict", z.ZodTypeAny, {
|
|
1237
|
+
manifest: string;
|
|
1238
|
+
claims: string;
|
|
1239
|
+
productId: string;
|
|
1240
|
+
}, {
|
|
1241
|
+
manifest: string;
|
|
1242
|
+
claims: string;
|
|
1243
|
+
productId: string;
|
|
1244
|
+
}>>;
|
|
1245
|
+
exceptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1246
|
+
ruleId: z.ZodEnum<["human-docs", "llms-and-raw-source", "agent-handoffs", "contribution", "metadata", "cross-links", "tested-quickstarts", "visual-explanations", "structured-diagrams"]>;
|
|
1247
|
+
reason: z.ZodString;
|
|
1248
|
+
approvedBy: z.ZodString;
|
|
1249
|
+
trackingUrl: z.ZodString;
|
|
1250
|
+
}, "strict", z.ZodTypeAny, {
|
|
1251
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1252
|
+
reason: string;
|
|
1253
|
+
approvedBy: string;
|
|
1254
|
+
trackingUrl: string;
|
|
1255
|
+
}, {
|
|
1256
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1257
|
+
reason: string;
|
|
1258
|
+
approvedBy: string;
|
|
1259
|
+
trackingUrl: string;
|
|
1260
|
+
}>, "many">>;
|
|
1261
|
+
}, "strict", z.ZodTypeAny, {
|
|
1262
|
+
metadata?: {
|
|
1263
|
+
path: string;
|
|
1264
|
+
contains: string[];
|
|
1265
|
+
}[] | undefined;
|
|
1266
|
+
rawSources?: string[] | undefined;
|
|
1267
|
+
contributionPaths?: string[] | undefined;
|
|
1268
|
+
links?: {
|
|
1269
|
+
paths: string[];
|
|
1270
|
+
url: string;
|
|
1271
|
+
}[] | undefined;
|
|
1272
|
+
quickstarts?: {
|
|
1273
|
+
id: string;
|
|
1274
|
+
doc: string;
|
|
1275
|
+
test: string;
|
|
1276
|
+
command: string;
|
|
1277
|
+
testContains: string[];
|
|
1278
|
+
}[] | undefined;
|
|
1279
|
+
visuals?: string[] | undefined;
|
|
1280
|
+
diagrams?: {
|
|
1281
|
+
path: string;
|
|
1282
|
+
contains: string[];
|
|
1283
|
+
}[] | undefined;
|
|
1284
|
+
ecosystemContract?: {
|
|
1285
|
+
manifest: string;
|
|
1286
|
+
claims: string;
|
|
1287
|
+
productId: string;
|
|
1288
|
+
} | undefined;
|
|
1289
|
+
exceptions?: {
|
|
1290
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1291
|
+
reason: string;
|
|
1292
|
+
approvedBy: string;
|
|
1293
|
+
trackingUrl: string;
|
|
1294
|
+
}[] | undefined;
|
|
1295
|
+
}, {
|
|
1296
|
+
metadata?: {
|
|
1297
|
+
path: string;
|
|
1298
|
+
contains: string[];
|
|
1299
|
+
}[] | undefined;
|
|
1300
|
+
rawSources?: string[] | undefined;
|
|
1301
|
+
contributionPaths?: string[] | undefined;
|
|
1302
|
+
links?: {
|
|
1303
|
+
paths: string[];
|
|
1304
|
+
url: string;
|
|
1305
|
+
}[] | undefined;
|
|
1306
|
+
quickstarts?: {
|
|
1307
|
+
id: string;
|
|
1308
|
+
doc: string;
|
|
1309
|
+
test: string;
|
|
1310
|
+
command: string;
|
|
1311
|
+
testContains: string[];
|
|
1312
|
+
}[] | undefined;
|
|
1313
|
+
visuals?: string[] | undefined;
|
|
1314
|
+
diagrams?: {
|
|
1315
|
+
path: string;
|
|
1316
|
+
contains: string[];
|
|
1317
|
+
}[] | undefined;
|
|
1318
|
+
ecosystemContract?: {
|
|
1319
|
+
manifest: string;
|
|
1320
|
+
claims: string;
|
|
1321
|
+
productId: string;
|
|
1322
|
+
} | undefined;
|
|
1323
|
+
exceptions?: {
|
|
1324
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1325
|
+
reason: string;
|
|
1326
|
+
approvedBy: string;
|
|
1327
|
+
trackingUrl: string;
|
|
1328
|
+
}[] | undefined;
|
|
1329
|
+
}>, {
|
|
1330
|
+
metadata?: {
|
|
1331
|
+
path: string;
|
|
1332
|
+
contains: string[];
|
|
1333
|
+
}[] | undefined;
|
|
1334
|
+
rawSources?: string[] | undefined;
|
|
1335
|
+
contributionPaths?: string[] | undefined;
|
|
1336
|
+
links?: {
|
|
1337
|
+
paths: string[];
|
|
1338
|
+
url: string;
|
|
1339
|
+
}[] | undefined;
|
|
1340
|
+
quickstarts?: {
|
|
1341
|
+
id: string;
|
|
1342
|
+
doc: string;
|
|
1343
|
+
test: string;
|
|
1344
|
+
command: string;
|
|
1345
|
+
testContains: string[];
|
|
1346
|
+
}[] | undefined;
|
|
1347
|
+
visuals?: string[] | undefined;
|
|
1348
|
+
diagrams?: {
|
|
1349
|
+
path: string;
|
|
1350
|
+
contains: string[];
|
|
1351
|
+
}[] | undefined;
|
|
1352
|
+
ecosystemContract?: {
|
|
1353
|
+
manifest: string;
|
|
1354
|
+
claims: string;
|
|
1355
|
+
productId: string;
|
|
1356
|
+
} | undefined;
|
|
1357
|
+
exceptions?: {
|
|
1358
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1359
|
+
reason: string;
|
|
1360
|
+
approvedBy: string;
|
|
1361
|
+
trackingUrl: string;
|
|
1362
|
+
}[] | undefined;
|
|
1363
|
+
}, {
|
|
1364
|
+
metadata?: {
|
|
1365
|
+
path: string;
|
|
1366
|
+
contains: string[];
|
|
1367
|
+
}[] | undefined;
|
|
1368
|
+
rawSources?: string[] | undefined;
|
|
1369
|
+
contributionPaths?: string[] | undefined;
|
|
1370
|
+
links?: {
|
|
1371
|
+
paths: string[];
|
|
1372
|
+
url: string;
|
|
1373
|
+
}[] | undefined;
|
|
1374
|
+
quickstarts?: {
|
|
1375
|
+
id: string;
|
|
1376
|
+
doc: string;
|
|
1377
|
+
test: string;
|
|
1378
|
+
command: string;
|
|
1379
|
+
testContains: string[];
|
|
1380
|
+
}[] | undefined;
|
|
1381
|
+
visuals?: string[] | undefined;
|
|
1382
|
+
diagrams?: {
|
|
1383
|
+
path: string;
|
|
1384
|
+
contains: string[];
|
|
1385
|
+
}[] | undefined;
|
|
1386
|
+
ecosystemContract?: {
|
|
1387
|
+
manifest: string;
|
|
1388
|
+
claims: string;
|
|
1389
|
+
productId: string;
|
|
1390
|
+
} | undefined;
|
|
1391
|
+
exceptions?: {
|
|
1392
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1393
|
+
reason: string;
|
|
1394
|
+
approvedBy: string;
|
|
1395
|
+
trackingUrl: string;
|
|
1396
|
+
}[] | undefined;
|
|
1397
|
+
}>>;
|
|
1398
|
+
}, "strict", z.ZodTypeAny, {
|
|
1399
|
+
documentationStandardV1?: {
|
|
1400
|
+
metadata?: {
|
|
1401
|
+
path: string;
|
|
1402
|
+
contains: string[];
|
|
1403
|
+
}[] | undefined;
|
|
1404
|
+
rawSources?: string[] | undefined;
|
|
1405
|
+
contributionPaths?: string[] | undefined;
|
|
1406
|
+
links?: {
|
|
1407
|
+
paths: string[];
|
|
1408
|
+
url: string;
|
|
1409
|
+
}[] | undefined;
|
|
1410
|
+
quickstarts?: {
|
|
1411
|
+
id: string;
|
|
1412
|
+
doc: string;
|
|
1413
|
+
test: string;
|
|
1414
|
+
command: string;
|
|
1415
|
+
testContains: string[];
|
|
1416
|
+
}[] | undefined;
|
|
1417
|
+
visuals?: string[] | undefined;
|
|
1418
|
+
diagrams?: {
|
|
1419
|
+
path: string;
|
|
1420
|
+
contains: string[];
|
|
1421
|
+
}[] | undefined;
|
|
1422
|
+
ecosystemContract?: {
|
|
1423
|
+
manifest: string;
|
|
1424
|
+
claims: string;
|
|
1425
|
+
productId: string;
|
|
1426
|
+
} | undefined;
|
|
1427
|
+
exceptions?: {
|
|
1428
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1429
|
+
reason: string;
|
|
1430
|
+
approvedBy: string;
|
|
1431
|
+
trackingUrl: string;
|
|
1432
|
+
}[] | undefined;
|
|
1433
|
+
} | undefined;
|
|
1434
|
+
}, {
|
|
1435
|
+
documentationStandardV1?: {
|
|
1436
|
+
metadata?: {
|
|
1437
|
+
path: string;
|
|
1438
|
+
contains: string[];
|
|
1439
|
+
}[] | undefined;
|
|
1440
|
+
rawSources?: string[] | undefined;
|
|
1441
|
+
contributionPaths?: string[] | undefined;
|
|
1442
|
+
links?: {
|
|
1443
|
+
paths: string[];
|
|
1444
|
+
url: string;
|
|
1445
|
+
}[] | undefined;
|
|
1446
|
+
quickstarts?: {
|
|
1447
|
+
id: string;
|
|
1448
|
+
doc: string;
|
|
1449
|
+
test: string;
|
|
1450
|
+
command: string;
|
|
1451
|
+
testContains: string[];
|
|
1452
|
+
}[] | undefined;
|
|
1453
|
+
visuals?: string[] | undefined;
|
|
1454
|
+
diagrams?: {
|
|
1455
|
+
path: string;
|
|
1456
|
+
contains: string[];
|
|
1457
|
+
}[] | undefined;
|
|
1458
|
+
ecosystemContract?: {
|
|
1459
|
+
manifest: string;
|
|
1460
|
+
claims: string;
|
|
1461
|
+
productId: string;
|
|
1462
|
+
} | undefined;
|
|
1463
|
+
exceptions?: {
|
|
1464
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1465
|
+
reason: string;
|
|
1466
|
+
approvedBy: string;
|
|
1467
|
+
trackingUrl: string;
|
|
1468
|
+
}[] | undefined;
|
|
1469
|
+
} | undefined;
|
|
1470
|
+
}>>;
|
|
652
1471
|
}, "strict", z.ZodTypeAny, {
|
|
653
1472
|
schemaVersion: 1;
|
|
654
1473
|
corpus: {
|
|
@@ -726,8 +1545,8 @@ declare const DocBridgeConfigV1Schema: z.ZodObject<{
|
|
|
726
1545
|
} | undefined;
|
|
727
1546
|
gates?: {
|
|
728
1547
|
options?: Record<string, unknown> | undefined;
|
|
729
|
-
include?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size")[] | undefined;
|
|
730
|
-
exclude?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size")[] | undefined;
|
|
1548
|
+
include?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size" | "documentation-standard-v1")[] | undefined;
|
|
1549
|
+
exclude?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size" | "documentation-standard-v1")[] | undefined;
|
|
731
1550
|
preset?: "strict" | "minimal" | "standard" | "playbook" | undefined;
|
|
732
1551
|
} | undefined;
|
|
733
1552
|
surfaces?: {
|
|
@@ -780,6 +1599,43 @@ declare const DocBridgeConfigV1Schema: z.ZodObject<{
|
|
|
780
1599
|
runtime?: "custom" | "agentskit" | undefined;
|
|
781
1600
|
runtimeModule?: string | undefined;
|
|
782
1601
|
} | undefined;
|
|
1602
|
+
conformance?: {
|
|
1603
|
+
documentationStandardV1?: {
|
|
1604
|
+
metadata?: {
|
|
1605
|
+
path: string;
|
|
1606
|
+
contains: string[];
|
|
1607
|
+
}[] | undefined;
|
|
1608
|
+
rawSources?: string[] | undefined;
|
|
1609
|
+
contributionPaths?: string[] | undefined;
|
|
1610
|
+
links?: {
|
|
1611
|
+
paths: string[];
|
|
1612
|
+
url: string;
|
|
1613
|
+
}[] | undefined;
|
|
1614
|
+
quickstarts?: {
|
|
1615
|
+
id: string;
|
|
1616
|
+
doc: string;
|
|
1617
|
+
test: string;
|
|
1618
|
+
command: string;
|
|
1619
|
+
testContains: string[];
|
|
1620
|
+
}[] | undefined;
|
|
1621
|
+
visuals?: string[] | undefined;
|
|
1622
|
+
diagrams?: {
|
|
1623
|
+
path: string;
|
|
1624
|
+
contains: string[];
|
|
1625
|
+
}[] | undefined;
|
|
1626
|
+
ecosystemContract?: {
|
|
1627
|
+
manifest: string;
|
|
1628
|
+
claims: string;
|
|
1629
|
+
productId: string;
|
|
1630
|
+
} | undefined;
|
|
1631
|
+
exceptions?: {
|
|
1632
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1633
|
+
reason: string;
|
|
1634
|
+
approvedBy: string;
|
|
1635
|
+
trackingUrl: string;
|
|
1636
|
+
}[] | undefined;
|
|
1637
|
+
} | undefined;
|
|
1638
|
+
} | undefined;
|
|
783
1639
|
}, {
|
|
784
1640
|
schemaVersion: 1;
|
|
785
1641
|
corpus: {
|
|
@@ -857,8 +1713,8 @@ declare const DocBridgeConfigV1Schema: z.ZodObject<{
|
|
|
857
1713
|
} | undefined;
|
|
858
1714
|
gates?: {
|
|
859
1715
|
options?: Record<string, unknown> | undefined;
|
|
860
|
-
include?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size")[] | undefined;
|
|
861
|
-
exclude?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size")[] | undefined;
|
|
1716
|
+
include?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size" | "documentation-standard-v1")[] | undefined;
|
|
1717
|
+
exclude?: ("index-freshness" | "human-guide-links" | "link-rot" | "okf-type" | "docs-style" | "routing-currency" | "bootstrap-size" | "documentation-standard-v1")[] | undefined;
|
|
862
1718
|
preset?: "strict" | "minimal" | "standard" | "playbook" | undefined;
|
|
863
1719
|
} | undefined;
|
|
864
1720
|
surfaces?: {
|
|
@@ -911,9 +1767,48 @@ declare const DocBridgeConfigV1Schema: z.ZodObject<{
|
|
|
911
1767
|
runtime?: "custom" | "agentskit" | undefined;
|
|
912
1768
|
runtimeModule?: string | undefined;
|
|
913
1769
|
} | undefined;
|
|
1770
|
+
conformance?: {
|
|
1771
|
+
documentationStandardV1?: {
|
|
1772
|
+
metadata?: {
|
|
1773
|
+
path: string;
|
|
1774
|
+
contains: string[];
|
|
1775
|
+
}[] | undefined;
|
|
1776
|
+
rawSources?: string[] | undefined;
|
|
1777
|
+
contributionPaths?: string[] | undefined;
|
|
1778
|
+
links?: {
|
|
1779
|
+
paths: string[];
|
|
1780
|
+
url: string;
|
|
1781
|
+
}[] | undefined;
|
|
1782
|
+
quickstarts?: {
|
|
1783
|
+
id: string;
|
|
1784
|
+
doc: string;
|
|
1785
|
+
test: string;
|
|
1786
|
+
command: string;
|
|
1787
|
+
testContains: string[];
|
|
1788
|
+
}[] | undefined;
|
|
1789
|
+
visuals?: string[] | undefined;
|
|
1790
|
+
diagrams?: {
|
|
1791
|
+
path: string;
|
|
1792
|
+
contains: string[];
|
|
1793
|
+
}[] | undefined;
|
|
1794
|
+
ecosystemContract?: {
|
|
1795
|
+
manifest: string;
|
|
1796
|
+
claims: string;
|
|
1797
|
+
productId: string;
|
|
1798
|
+
} | undefined;
|
|
1799
|
+
exceptions?: {
|
|
1800
|
+
ruleId: "human-docs" | "llms-and-raw-source" | "agent-handoffs" | "contribution" | "metadata" | "cross-links" | "tested-quickstarts" | "visual-explanations" | "structured-diagrams";
|
|
1801
|
+
reason: string;
|
|
1802
|
+
approvedBy: string;
|
|
1803
|
+
trackingUrl: string;
|
|
1804
|
+
}[] | undefined;
|
|
1805
|
+
} | undefined;
|
|
1806
|
+
} | undefined;
|
|
914
1807
|
}>;
|
|
915
1808
|
type DocBridgeConfigV1 = z.infer<typeof DocBridgeConfigV1Schema>;
|
|
916
1809
|
type AgentCorpusConfig = z.infer<typeof AgentCorpusConfigSchema>;
|
|
1810
|
+
type DocumentationStandardV1Config = z.infer<typeof DocumentationStandardV1ConfigSchema>;
|
|
1811
|
+
type DocumentationStandardRuleId = z.infer<typeof DocumentationStandardRuleIdSchema>;
|
|
917
1812
|
|
|
918
1813
|
/** Type-safe config helper for `doc-bridge.config.ts`. */
|
|
919
1814
|
declare const defineConfig: (config: DocBridgeConfigV1) => DocBridgeConfigV1;
|
|
@@ -938,4 +1833,4 @@ declare const resolveProjectRoot: (start?: string) => string;
|
|
|
938
1833
|
/** Project root for a loaded config file path (directory of the config). */
|
|
939
1834
|
declare const projectRootFromConfigPath: (configFilePath: string, projectRootField?: string) => string;
|
|
940
1835
|
|
|
941
|
-
export { type AgentCorpusConfig as A, ConfigNotFoundError as C, type DocBridgeConfigV1 as D, HumanCorpusConfigSchema as H, type LoadConfigOptions as L,
|
|
1836
|
+
export { type AgentCorpusConfig as A, ConfigNotFoundError as C, type DocBridgeConfigV1 as D, EcosystemContractEvidenceSchema as E, HumanCorpusConfigSchema as H, type LoadConfigOptions as L, type DocumentationStandardRuleId as a, DocBridgeConfigV1Schema as b, DocumentationStandardRuleIdSchema as c, type DocumentationStandardV1Config as d, DocumentationStandardV1ConfigSchema as e, type LoadConfigResult as f, applyConfigDefaults as g, defineConfig as h, AgentCorpusConfigSchema as i, ConformanceConfigSchema as j, loadConfig as l, projectRootFromConfigPath as p, resolveProjectRoot as r };
|