@farming-labs/docs 0.2.53 → 0.2.54
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/dist/agent-BXvi0uhS.mjs +623 -0
- package/dist/{agent-BMxMpEa0.mjs → agent-DXkXi-pS.mjs} +590 -19
- package/dist/agent-evals-BD17jOqL.mjs +1166 -0
- package/dist/{agent-export--X9Go-wj.mjs → agent-export-n-a0GbeU.mjs} +9 -8
- package/dist/agent-scope-B8lptqCd.mjs +283 -0
- package/dist/agent-surface-drift-LS8zQgbq.mjs +1429 -0
- package/dist/{agents-CW-zTNKP.mjs → agents-BJaRQimo.mjs} +7 -6
- package/dist/{analytics-BZEwTK-8.mjs → analytics-Bx44lg6d.mjs} +1 -1
- package/dist/cli/index.mjs +29 -29
- package/dist/client/react.d.mts +1 -1
- package/dist/client/react.mjs +1 -1
- package/dist/{cloud-zs0qAnKJ.mjs → cloud-HWFlbfLJ.mjs} +4 -4
- package/dist/{cloud-ask-ai-BFlx8VMO.mjs → cloud-ask-ai-1k0q6OAH.mjs} +1 -1
- package/dist/{cloud-ask-ai-CMzYVzVX.d.mts → cloud-ask-ai-466g6uAi.d.mts} +1 -1
- package/dist/code-blocks-C9awWzEQ.mjs +871 -0
- package/dist/codeblocks-BzfkREEC.mjs +250 -0
- package/dist/{config-DhIyFsy9.mjs → config-CydaZ5PB.mjs} +52 -11
- package/dist/{dev-DFeVU2Ui.mjs → dev-BA2kRuCn.mjs} +3 -3
- package/dist/docs-cloud-server.d.mts +2 -2
- package/dist/docs-cloud-server.mjs +2 -2
- package/dist/{doctor-CkM5tKdD.mjs → doctor-CQpQ2zZm.mjs} +150 -32
- package/dist/{downgrade-Dj_KXV11.mjs → downgrade-BStNhyCc.mjs} +2 -2
- package/dist/index.d.mts +36 -17
- package/dist/index.mjs +6 -7
- package/dist/{init-Cmz-oqnp.mjs → init-gnHQ_Pz9.mjs} +3 -3
- package/dist/{mcp-B4Q1PN93.mjs → mcp-DnxZZWpY.mjs} +6 -5
- package/dist/mcp.d.mts +22 -4
- package/dist/mcp.mjs +520 -43
- package/dist/{package-version-DxnTZH4m.mjs → package-version-DRIc08EU.mjs} +1 -1
- package/dist/{reading-time-BuK2YL23.mjs → reading-time-BrTd3DIh.mjs} +2 -3
- package/dist/{review-BEsbm0l2.mjs → review-B6gyEFkD.mjs} +149 -14
- package/dist/{robots-BOwkq9du.mjs → robots-4BUJxlvV.mjs} +4 -5
- package/dist/{robots-C6uQG-fS.mjs → robots-DAptQnkx.mjs} +1 -1
- package/dist/{search-CJNLkdjX.mjs → search-CJIC1Cqo.mjs} +1 -2
- package/dist/{search-CtAXkk_J.mjs → search-CbPm2x5g.mjs} +6 -5
- package/dist/{search-CTu6Bvq-.d.mts → search-CfWvmVYA.d.mts} +1 -1
- package/dist/server.d.mts +108 -5
- package/dist/server.mjs +9 -9
- package/dist/{sitemap-OPb8EdNe.mjs → sitemap-D6nP3J1Q.mjs} +8 -7
- package/dist/{sitemap-server-DnilMEiZ.mjs → sitemap-server-wsNLyVkb.mjs} +1 -1
- package/dist/{types-CdKu8KmO.d.mts → types-BVgucdVm.d.mts} +77 -1
- package/dist/{upgrade-BNdBB9tQ.mjs → upgrade-CXYRNV0C.mjs} +2 -2
- package/package.json +1 -1
- package/dist/agent-2t4kZLGo.mjs +0 -10
- package/dist/agent-contract-b0akaPcg.mjs +0 -573
- package/dist/codeblocks-DWM4IJPL.mjs +0 -1710
- package/dist/review-BHdy75TE.mjs +0 -541
- /package/dist/{cloud-analytics-Dlk_byos.mjs → cloud-analytics-CSyFE6SS.mjs} +0 -0
- /package/dist/{errors-BxfYhp1L.mjs → errors-BFUtdZfC.mjs} +0 -0
- /package/dist/{templates-Bty9M6lA.mjs → templates-1Cod8KrJ.mjs} +0 -0
- /package/dist/{utils-CMZTjRQT.mjs → utils-DBCCkkJS.mjs} +0 -0
|
@@ -1,14 +1,16 @@
|
|
|
1
|
-
import "./
|
|
2
|
-
import "./
|
|
3
|
-
import {
|
|
4
|
-
import "./search-
|
|
5
|
-
import { a as analyzeDocsRobotsTxt, n as DEFAULT_ROBOTS_TXT_ROUTE, u as resolveDocsRobotsConfig } from "./robots-
|
|
6
|
-
import "./sitemap-server-
|
|
7
|
-
import {
|
|
1
|
+
import { i as scanDocsPageTargets, n as compactAgentDocs, r as inspectAgentCompactionState } from "./agent-BXvi0uhS.mjs";
|
|
2
|
+
import "./reading-time-BrTd3DIh.mjs";
|
|
3
|
+
import { Bt as PAGE_AGENT_CONTRACT_FIELDS, Dt as DEFAULT_SITEMAP_XML_ROUTE, Et as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, I as buildDocsMcpEndpointCandidates, M as buildDocsAgentDiscoverySpec, Nt as resolveDocsSitemapConfig, O as DOCS_CONFIG_MAP_TOP_LEVEL_KEYS, P as buildDocsConfigMap, S as DEFAULT_MCP_WELL_KNOWN_ROUTE, T as DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, Tt as DEFAULT_SITEMAP_MD_ROUTE, b as DEFAULT_MCP_PUBLIC_ROUTE, c as DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, f as DEFAULT_DOCS_CONFIG_ROUTE, h as DEFAULT_LLMS_FULL_TXT_ROUTE, i as DEFAULT_AGENT_FEEDBACK_ROUTE, l as DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, n as DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, t as DEFAULT_AGENTS_MD_ROUTE, u as DEFAULT_DOCS_API_ROUTE, v as DEFAULT_LLMS_TXT_ROUTE, w as DEFAULT_SKILL_MD_ROUTE } from "./agent-DXkXi-pS.mjs";
|
|
4
|
+
import "./search-CJIC1Cqo.mjs";
|
|
5
|
+
import { a as analyzeDocsRobotsTxt, n as DEFAULT_ROBOTS_TXT_ROUTE, u as resolveDocsRobotsConfig } from "./robots-DAptQnkx.mjs";
|
|
6
|
+
import "./sitemap-server-wsNLyVkb.mjs";
|
|
7
|
+
import { t as runDocsGoldenTasks } from "./agent-evals-BD17jOqL.mjs";
|
|
8
|
+
import { createFilesystemDocsMcpSource, getDocsConfigSchema, resolveDocsMcpConfig } from "./mcp.mjs";
|
|
9
|
+
import "./code-blocks-C9awWzEQ.mjs";
|
|
8
10
|
import "./server.mjs";
|
|
9
|
-
import { a as
|
|
10
|
-
import { t as detectFramework } from "./utils-
|
|
11
|
-
import { n as
|
|
11
|
+
import { a as loadDocsConfigModuleResultWithProjectEnv, h as resolveDocsContentDir, l as readNavTitle, m as resolveDocsConfigPath, p as readTopLevelStringProperty, r as extractTopLevelConfigObject, s as readBooleanProperty, t as extractNestedObjectLiteral } from "./config-CydaZ5PB.mjs";
|
|
12
|
+
import { t as detectFramework } from "./utils-DBCCkkJS.mjs";
|
|
13
|
+
import { n as analyzeAgentUsefulness, r as createAgentUsefulnessPagesFromMcp, t as analyzeAgentSurfaceDrift } from "./agent-surface-drift-LS8zQgbq.mjs";
|
|
12
14
|
import { existsSync, lstatSync, readFileSync, readdirSync } from "node:fs";
|
|
13
15
|
import path from "node:path";
|
|
14
16
|
import { LATEST_PROTOCOL_VERSION } from "@modelcontextprotocol/sdk/types.js";
|
|
@@ -584,8 +586,18 @@ function navigationScore(navigationCoverage) {
|
|
|
584
586
|
score: 0
|
|
585
587
|
};
|
|
586
588
|
}
|
|
587
|
-
|
|
588
|
-
|
|
589
|
+
const AGENT_OPTIMIZATION_BLOCKING_CHECKS = new Set([
|
|
590
|
+
"surface-drift",
|
|
591
|
+
"agent-context-quality",
|
|
592
|
+
"agent-task-completeness",
|
|
593
|
+
"agent-applicability",
|
|
594
|
+
"command-health",
|
|
595
|
+
"related-coverage",
|
|
596
|
+
"golden-tasks"
|
|
597
|
+
]);
|
|
598
|
+
function gradeForAgentScore(score, checks = []) {
|
|
599
|
+
const hasBlockingFailure = checks.some((check) => check.status === "fail" && AGENT_OPTIMIZATION_BLOCKING_CHECKS.has(check.id));
|
|
600
|
+
if (score >= 90 && !hasBlockingFailure) return "Agent-optimized";
|
|
589
601
|
if (score >= 75) return "Agent-ready";
|
|
590
602
|
if (score >= 60) return "Promising";
|
|
591
603
|
return "Needs work";
|
|
@@ -632,6 +644,20 @@ function buildCoverage(pages) {
|
|
|
632
644
|
}
|
|
633
645
|
};
|
|
634
646
|
}
|
|
647
|
+
function scoreUsefulnessCoverage(completed, total, maxScore) {
|
|
648
|
+
if (total === 0) return {
|
|
649
|
+
status: "warn",
|
|
650
|
+
score: 0,
|
|
651
|
+
coverage: 0
|
|
652
|
+
};
|
|
653
|
+
const coverage = Math.round(completed / total * 100);
|
|
654
|
+
const score = Math.round(coverage / 100 * maxScore);
|
|
655
|
+
return {
|
|
656
|
+
status: coverage >= 80 ? "pass" : coverage > 0 ? "warn" : "fail",
|
|
657
|
+
score,
|
|
658
|
+
coverage
|
|
659
|
+
};
|
|
660
|
+
}
|
|
635
661
|
function buildCompactionCoverage(rootDir, contentDir, entry, pages, defaults) {
|
|
636
662
|
const targets = scanDocsPageTargets(rootDir, contentDir, entry);
|
|
637
663
|
const targetsBySlug = new Map(targets.map((target) => [target.slug, target]));
|
|
@@ -1042,6 +1068,44 @@ async function probeMcpRouteCandidates(baseUrl, routes, expectedTools) {
|
|
|
1042
1068
|
function asRecord(value) {
|
|
1043
1069
|
return value && typeof value === "object" ? value : void 0;
|
|
1044
1070
|
}
|
|
1071
|
+
function isPlainRecord(value) {
|
|
1072
|
+
return Boolean(asRecord(value)) && !Array.isArray(value);
|
|
1073
|
+
}
|
|
1074
|
+
function resolveGoldenEvaluationTasks(evaluationInput) {
|
|
1075
|
+
if (evaluationInput === void 0 || typeof evaluationInput === "boolean") return void 0;
|
|
1076
|
+
if (!isPlainRecord(evaluationInput)) return { evaluationConfig: evaluationInput };
|
|
1077
|
+
if (evaluationInput.enabled === false) return void 0;
|
|
1078
|
+
if ("enabled" in evaluationInput && typeof evaluationInput.enabled !== "boolean") return evaluationInput;
|
|
1079
|
+
if (!("tasks" in evaluationInput)) return void 0;
|
|
1080
|
+
const runtimeTasks = evaluationInput.tasks;
|
|
1081
|
+
if (!Array.isArray(runtimeTasks)) return runtimeTasks;
|
|
1082
|
+
return runtimeTasks.map((task) => {
|
|
1083
|
+
if (!isPlainRecord(task)) return task;
|
|
1084
|
+
return {
|
|
1085
|
+
...task,
|
|
1086
|
+
tokenBudget: task.tokenBudget ?? evaluationInput.tokenBudget,
|
|
1087
|
+
topK: task.topK ?? evaluationInput.topK
|
|
1088
|
+
};
|
|
1089
|
+
});
|
|
1090
|
+
}
|
|
1091
|
+
function isNonEmptyString(value) {
|
|
1092
|
+
return typeof value === "string" && value.trim().length > 0;
|
|
1093
|
+
}
|
|
1094
|
+
function isBooleanRecord(value) {
|
|
1095
|
+
const record = asRecord(value);
|
|
1096
|
+
return Boolean(record && Object.keys(record).length > 0 && Object.values(record).every((item) => typeof item === "boolean"));
|
|
1097
|
+
}
|
|
1098
|
+
function isHostedAgentDiscoveryManifest(value) {
|
|
1099
|
+
const root = asRecord(value);
|
|
1100
|
+
const site = asRecord(root?.site);
|
|
1101
|
+
const capabilities = asRecord(root?.capabilities);
|
|
1102
|
+
const api = asRecord(root?.api);
|
|
1103
|
+
const config = asRecord(root?.config);
|
|
1104
|
+
const search = asRecord(root?.search);
|
|
1105
|
+
const mcp = asRecord(root?.mcp);
|
|
1106
|
+
const agentContractFields = asRecord(asRecord(root?.agentContract)?.fields);
|
|
1107
|
+
return Boolean(root && isNonEmptyString(root.version) && isNonEmptyString(root.name) && isNonEmptyString(root.baseUrl) && isNonEmptyString(site?.entry) && typeof capabilities?.search === "boolean" && typeof capabilities?.mcp === "boolean" && isNonEmptyString(api?.docs) && isNonEmptyString(api?.config) && isNonEmptyString(config?.endpoint) && typeof search?.enabled === "boolean" && isNonEmptyString(search?.endpoint) && typeof mcp?.enabled === "boolean" && isNonEmptyString(mcp?.endpoint) && isBooleanRecord(mcp?.tools) && agentContractFields && Object.keys(agentContractFields).length > 0);
|
|
1108
|
+
}
|
|
1045
1109
|
function readDiscoveryRoute(value) {
|
|
1046
1110
|
return typeof value === "string" && value.startsWith("/") ? value : void 0;
|
|
1047
1111
|
}
|
|
@@ -1190,7 +1254,8 @@ async function buildHostedAgentChecks(url, pages) {
|
|
|
1190
1254
|
}
|
|
1191
1255
|
const checks = [];
|
|
1192
1256
|
const discovery = await probeJsonRoute(baseUrl, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE);
|
|
1193
|
-
|
|
1257
|
+
const discoveryManifestValid = discovery.ok && isHostedAgentDiscoveryManifest(discovery.body);
|
|
1258
|
+
checks.push(makeCheck("hosted-agent-discovery", "Hosted agent discovery", discoveryManifestValid ? "pass" : "fail", discoveryManifestValid ? 5 : 0, 5, `${baseUrl}: ${discovery.ok && !discoveryManifestValid ? `${discovery.detail} The payload is not a complete agent discovery manifest.` : discovery.detail}`, discoveryManifestValid ? void 0 : `Make sure ${DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE} returns the complete agent discovery manifest from the shared docs API.`));
|
|
1194
1259
|
const llms = await Promise.all([probeTextRoute(baseUrl, DEFAULT_LLMS_TXT_ROUTE), probeTextRoute(baseUrl, DEFAULT_LLMS_FULL_TXT_ROUTE)]);
|
|
1195
1260
|
const llmsPassed = llms.filter((result) => result.ok).length;
|
|
1196
1261
|
checks.push(makeCheck("hosted-llms", "Hosted llms.txt", llmsPassed === llms.length ? "pass" : llmsPassed > 0 ? "warn" : "fail", llmsPassed === llms.length ? 5 : llmsPassed > 0 ? 3 : 0, 5, llms.map((result) => result.detail).join(" "), llmsPassed === llms.length ? void 0 : "Verify deployed /llms.txt and /llms-full.txt routes return non-empty text."));
|
|
@@ -1247,18 +1312,6 @@ async function buildHostedAgentChecks(url, pages) {
|
|
|
1247
1312
|
checks
|
|
1248
1313
|
};
|
|
1249
1314
|
}
|
|
1250
|
-
async function loadDocsConfigModuleWithProjectEnv(rootDir, explicitPath) {
|
|
1251
|
-
const env = loadProjectEnv(rootDir);
|
|
1252
|
-
const injectedKeys = Object.entries(env).filter(([key]) => process.env[key] === void 0).map(([key, value]) => {
|
|
1253
|
-
process.env[key] = value;
|
|
1254
|
-
return key;
|
|
1255
|
-
});
|
|
1256
|
-
try {
|
|
1257
|
-
return await loadDocsConfigModule(rootDir, explicitPath);
|
|
1258
|
-
} finally {
|
|
1259
|
-
for (const key of injectedKeys) delete process.env[key];
|
|
1260
|
-
}
|
|
1261
|
-
}
|
|
1262
1315
|
function makeCheck(id, title, status, score, maxScore, detail, recommendation) {
|
|
1263
1316
|
return {
|
|
1264
1317
|
id,
|
|
@@ -1306,8 +1359,8 @@ async function inspectAgentReadiness(options = {}) {
|
|
|
1306
1359
|
};
|
|
1307
1360
|
}
|
|
1308
1361
|
const configContent = readFileSync(configPath, "utf-8");
|
|
1309
|
-
const
|
|
1310
|
-
const config =
|
|
1362
|
+
const configLoad = await loadDocsConfigModuleResultWithProjectEnv(rootDir, options.configPath);
|
|
1363
|
+
const config = configLoad.status === "evaluated" ? configLoad.config : void 0;
|
|
1311
1364
|
const entry = config?.entry ?? readTopLevelStringProperty(configContent, "entry") ?? "docs";
|
|
1312
1365
|
const contentDir = config?.contentDir ?? resolveDocsContentDir(rootDir, configContent, entry);
|
|
1313
1366
|
const ordering = config?.ordering === "alphabetical" || config?.ordering === "numeric" || Array.isArray(config?.ordering) ? config.ordering : void 0;
|
|
@@ -1329,11 +1382,24 @@ async function inspectAgentReadiness(options = {}) {
|
|
|
1329
1382
|
});
|
|
1330
1383
|
const pages = await Promise.resolve(source.getPages());
|
|
1331
1384
|
const coverage = buildCoverage(pages);
|
|
1385
|
+
const usefulness = analyzeAgentUsefulness({
|
|
1386
|
+
rootDir,
|
|
1387
|
+
pages: createAgentUsefulnessPagesFromMcp(rootDir, pages),
|
|
1388
|
+
projectFramework: framework === "unknown" ? void 0 : framework
|
|
1389
|
+
});
|
|
1390
|
+
const evaluationInput = config?.agent?.evaluations;
|
|
1391
|
+
const evaluations = await runDocsGoldenTasks(pages, resolveGoldenEvaluationTasks(evaluationInput));
|
|
1332
1392
|
const compactionCoverage = buildCompactionCoverage(rootDir, contentDir, entry, pages, config?.agent?.compact ?? {});
|
|
1333
1393
|
coverage.compaction = compactionCoverage;
|
|
1334
1394
|
const metadataCoverage = buildMetadataCoverage(pages);
|
|
1335
1395
|
const metadataResult = metadataScore(metadataCoverage.descriptionCoverage, metadataCoverage.relatedCoverage);
|
|
1336
1396
|
const compactionResult = compactionFreshnessScore(compactionCoverage, compactConfigured);
|
|
1397
|
+
const contextQualityResult = scoreUsefulnessCoverage(usefulness.metrics.agentBlocks.useful, usefulness.metrics.agentBlocks.total, 15);
|
|
1398
|
+
const taskCompletenessResult = scoreUsefulnessCoverage(usefulness.metrics.taskCompleteness.completePages, usefulness.metrics.actionablePages, 15);
|
|
1399
|
+
const applicabilityIssueCount = usefulness.metrics.applicability.conflictingPages + usefulness.metrics.applicability.ambiguousPages + usefulness.metrics.applicability.mismatchedPages;
|
|
1400
|
+
const applicabilityResult = scoreUsefulnessCoverage(Math.max(0, usefulness.metrics.actionablePages - applicabilityIssueCount), usefulness.metrics.actionablePages, 10);
|
|
1401
|
+
const commandHealthResult = scoreUsefulnessCoverage(usefulness.metrics.commands.healthy, usefulness.metrics.commands.total, 10);
|
|
1402
|
+
const relatedCoverageResult = scoreUsefulnessCoverage(usefulness.metrics.related.coveredActionablePages, usefulness.metrics.actionablePages, 5);
|
|
1337
1403
|
const routeSurface = detectRouteSurface(rootDir, framework, staticExport, files);
|
|
1338
1404
|
const mcpConfig = resolveDocsMcpConfig(config?.mcp ?? void 0, { defaultName: siteTitle });
|
|
1339
1405
|
const sitemapConfig = resolveDocsSitemapConfig(config?.sitemap ?? readSitemapConfigFromStatic(configContent) ?? true);
|
|
@@ -1342,8 +1408,47 @@ async function inspectAgentReadiness(options = {}) {
|
|
|
1342
1408
|
const robotsPath = resolveRobotsFilePath(rootDir, framework, typeof robotsInput === "object" ? robotsInput : void 0);
|
|
1343
1409
|
const feedbackRoute = DEFAULT_AGENT_FEEDBACK_ROUTE;
|
|
1344
1410
|
const feedbackSchemaRoute = `${feedbackRoute}/schema`;
|
|
1411
|
+
const discovery = buildDocsAgentDiscoverySpec({
|
|
1412
|
+
origin: "http://localhost",
|
|
1413
|
+
entry,
|
|
1414
|
+
search: searchEnabled,
|
|
1415
|
+
mcp: mcpConfig,
|
|
1416
|
+
feedback: {
|
|
1417
|
+
enabled: agentFeedbackEnabled,
|
|
1418
|
+
route: feedbackRoute,
|
|
1419
|
+
schemaRoute: feedbackSchemaRoute
|
|
1420
|
+
}
|
|
1421
|
+
});
|
|
1422
|
+
const configuredAgentReviewPaths = configLoad.status === "evaluated" ? Object.values(buildDocsConfigMap(configLoad.config).pointers).map((pointer) => pointer.path).filter((optionPath) => optionPath === "agent" || optionPath.startsWith("agent.") || optionPath === "review" || optionPath.startsWith("review.")) : [];
|
|
1423
|
+
const surfaceDrift = analyzeAgentSurfaceDrift({
|
|
1424
|
+
configOptionPaths: [...new Set([...DOCS_CONFIG_MAP_TOP_LEVEL_KEYS, ...configuredAgentReviewPaths])],
|
|
1425
|
+
schemaOptions: getDocsConfigSchema().options,
|
|
1426
|
+
agentContractFields: PAGE_AGENT_CONTRACT_FIELDS,
|
|
1427
|
+
discovery,
|
|
1428
|
+
expected: {
|
|
1429
|
+
entry,
|
|
1430
|
+
search: {
|
|
1431
|
+
enabled: searchEnabled,
|
|
1432
|
+
endpoint: `${DEFAULT_DOCS_API_ROUTE}?query={query}`
|
|
1433
|
+
},
|
|
1434
|
+
mcp: {
|
|
1435
|
+
enabled: mcpConfig.enabled,
|
|
1436
|
+
endpoint: mcpConfig.route,
|
|
1437
|
+
tools: mcpConfig.tools
|
|
1438
|
+
},
|
|
1439
|
+
routes: {
|
|
1440
|
+
"api.docs": DEFAULT_DOCS_API_ROUTE,
|
|
1441
|
+
"api.config": DEFAULT_DOCS_CONFIG_ROUTE,
|
|
1442
|
+
"config.endpoint": DEFAULT_DOCS_CONFIG_ROUTE
|
|
1443
|
+
}
|
|
1444
|
+
}
|
|
1445
|
+
});
|
|
1345
1446
|
const checks = [];
|
|
1346
|
-
checks.push(makeCheck("config", "Docs config", "pass", 10, configCheckMax,
|
|
1447
|
+
checks.push(makeCheck("config", "Docs config", configLoad.status === "evaluated" ? "pass" : "warn", configLoad.status === "evaluated" ? 10 : 2, configCheckMax, configLoad.status === "evaluated" ? `Resolved ${path.relative(rootDir, configLoad.path).replace(/\\/g, "/")} and evaluated the config module.` : `Resolved ${path.relative(rootDir, configPath).replace(/\\/g, "/")} using static parsing fallback.`, configLoad.status === "evaluated" ? void 0 : "Fix docs.config module evaluation before relying on resolved diagnostic scores."));
|
|
1448
|
+
const canScoreSurfaceDrift = configLoad.status === "evaluated";
|
|
1449
|
+
checks.push(makeCheck("surface-drift", "Discovery/config/schema consistency", !canScoreSurfaceDrift ? "warn" : surfaceDrift.length === 0 ? "pass" : "fail", !canScoreSurfaceDrift ? 0 : surfaceDrift.length === 0 ? 10 : Math.max(0, 10 - surfaceDrift.length * 2), 10, !canScoreSurfaceDrift ? "Not scored because docs.config could not be evaluated; static parsing cannot prove discovery/config/schema consistency." : surfaceDrift.length === 0 ? "Resolved config, discovery metadata, MCP tool flags, config schema, and agent contract fields agree." : surfaceDrift.slice(0, 3).map((issue) => issue.message).join(" "), canScoreSurfaceDrift && surfaceDrift.length === 0 ? void 0 : canScoreSurfaceDrift ? "Align docs config, agent discovery, MCP tools, config schema, and the canonical page agent contract before publishing." : "Fix docs.config module evaluation so doctor can compare resolved config with discovery and schema surfaces."));
|
|
1450
|
+
const dynamicStaticFallback = configLoad.status === "static-fallback" && /(?:\.\.\.|process\.env|import\.meta\.env|\[[^\]]+\]\s*:|:\s*[A-Za-z_$][\w$]*\s*[,}])/u.test(configContent);
|
|
1451
|
+
checks.push(configLoad.status === "evaluated" ? makeCheck("config-confidence", "Config loading confidence", "pass", 5, 5, "High confidence: docs.config was evaluated with project-local environment values.") : makeCheck("config-confidence", "Config loading confidence", "warn", dynamicStaticFallback ? 1 : 2, 5, `${dynamicStaticFallback ? "Low" : "Partial"} confidence: only static config parsing succeeded. ${configLoad.error}`, "Fix docs.config module evaluation so doctor and review can inspect dynamic values, golden tasks, and resolved feature settings."));
|
|
1347
1452
|
const contentDirAbs = path.resolve(rootDir, contentDir);
|
|
1348
1453
|
checks.push(coverage.totalPages > 0 ? makeCheck("content", "Docs content", "pass", 10, 10, `Found ${coverage.totalPages} docs page${coverage.totalPages === 1 ? "" : "s"} in ${path.relative(rootDir, contentDirAbs).replace(/\\/g, "/")}.`) : makeCheck("content", "Docs content", "fail", 0, 10, `No folder-based docs pages were found in ${path.relative(rootDir, contentDirAbs).replace(/\\/g, "/")}.`, "Add index/page MDX files under the configured contentDir so the machine-readable surfaces have pages to serve."));
|
|
1349
1454
|
checks.push(makeCheck("api-route", "Docs API route", routeSurface.apiMounted ? "pass" : "fail", routeSurface.apiMounted ? 10 : 0, 10, routeSurface.apiDetail, routeSurface.apiMounted ? void 0 : "Wire the framework docs API route so /api/docs can serve markdown, llms.txt, sitemap, AGENTS.md, skill.md, and discovery responses."));
|
|
@@ -1379,7 +1484,16 @@ async function inspectAgentReadiness(options = {}) {
|
|
|
1379
1484
|
checks.push(makeCheck("metadata", "Page metadata", metadataResult.status, metadataResult.score, 5, coverage.totalPages > 0 ? `${metadataCoverage.describedPages}/${coverage.totalPages} pages include descriptions and ${metadataCoverage.relatedPages}/${coverage.totalPages} pages include related links (${metadataCoverage.descriptionCoverage}% described, ${metadataCoverage.relatedCoverage}% related).` : "No docs pages were available to score page metadata.", metadataCoverage.descriptionCoverage >= 75 ? void 0 : "Add page descriptions and related links to more docs pages so agent markdown output carries better context and navigation hints."));
|
|
1380
1485
|
const coverageResult = coverageScore(coverage.explicitCoverage);
|
|
1381
1486
|
checks.push(makeCheck("coverage", "Explicit page optimization", coverageResult.status, coverageResult.score, 10, coverage.totalPages > 0 ? `${coverage.explicitPages}/${coverage.totalPages} pages define explicit machine-only context (${coverage.pagesWithAgentFiles} agent.md, ${coverage.pagesWithAgentBlocks} Agent blocks, ${coverage.explicitCoverage}% of pages).` : "No docs pages were available to score explicit page optimization.", coverage.explicitCoverage >= 50 ? void 0 : "Add agent.md files or <Agent> blocks to more pages, or run docs agent compact to create page-level machine docs."));
|
|
1487
|
+
checks.push(makeCheck("agent-context-quality", "Agent context usefulness", contextQualityResult.status, contextQualityResult.score, 15, usefulness.metrics.agentBlocks.total > 0 ? `${usefulness.metrics.agentBlocks.useful}/${usefulness.metrics.agentBlocks.total} Agent blocks are specific and non-repetitive (${usefulness.metrics.agentBlocks.duplicate} duplicate, ${usefulness.metrics.agentBlocks.boilerplate} boilerplate, ${usefulness.metrics.agentBlocks.generic} generic).` : "No embedded Agent blocks were present; page contracts and sibling agent.md files remain available as alternatives.", usefulness.metrics.agentBlocks.total > 0 && usefulness.metrics.agentBlocks.useful === usefulness.metrics.agentBlocks.total ? void 0 : "Replace repeated Agent boilerplate with page-specific constraints, commands, files, expected results, and recovery guidance."));
|
|
1488
|
+
checks.push(makeCheck("agent-task-completeness", "Agent task completeness", taskCompletenessResult.status, taskCompletenessResult.score, 15, `${usefulness.metrics.taskCompleteness.completePages}/${usefulness.metrics.actionablePages} actionable pages include prerequisites, an expected result, and recovery guidance (${usefulness.metrics.taskCompleteness.coverage}% complete).`, usefulness.metrics.actionablePages > 0 && usefulness.metrics.taskCompleteness.coverage >= 80 ? void 0 : "Add prerequisites, observable outcomes or verification expectations, and rollback or resolved failure modes to actionable pages."));
|
|
1489
|
+
checks.push(makeCheck("agent-applicability", "Framework and version applicability", applicabilityResult.status, applicabilityResult.score, 10, `${usefulness.metrics.applicability.conflictingPages} conflicting, ${usefulness.metrics.applicability.ambiguousPages} ambiguous, and ${usefulness.metrics.applicability.mismatchedPages} project-mismatched actionable pages.`, usefulness.metrics.actionablePages > 0 && applicabilityIssueCount === 0 ? void 0 : "Declare consistent framework/version metadata in page frontmatter and agent.appliesTo so retrieval can select the right variant."));
|
|
1490
|
+
checks.push(makeCheck("command-health", "Documented command health", commandHealthResult.status, commandHealthResult.score, 10, `${usefulness.metrics.commands.healthy}/${usefulness.metrics.commands.total} statically inspected commands are healthy; ${usefulness.metrics.commands.unhealthy} are unhealthy and ${usefulness.metrics.commands.unverified} could not be verified safely.`, usefulness.metrics.commands.total > 0 && usefulness.metrics.commands.unhealthy === 0 && usefulness.metrics.commands.unverified === 0 ? void 0 : "Update broken or stale commands and make workspace selectors resolvable so scripts, working directories, package managers, and docs CLI subcommands can be verified."));
|
|
1491
|
+
checks.push(makeCheck("related-coverage", "Related-page task coverage", relatedCoverageResult.status, relatedCoverageResult.score, 5, `${usefulness.metrics.related.coveredActionablePages}/${usefulness.metrics.actionablePages} actionable pages link to a valid related docs route; ${usefulness.metrics.related.brokenLinks} related links are broken.`, usefulness.metrics.actionablePages > 0 && usefulness.metrics.related.coverage >= 80 && usefulness.metrics.related.brokenLinks === 0 ? void 0 : "Add and validate related routes on actionable pages so agents can expand context without guessing."));
|
|
1382
1492
|
checks.push(makeCheck("compact", "Agent compaction freshness", compactionResult.status, compactionResult.score, 5, `${compactionCoverage.freshGeneratedPages} fresh, ${compactionCoverage.staleGeneratedPages} stale, ${compactionCoverage.modifiedGeneratedPages} modified, ${compactionCoverage.unknownGeneratedPages} unknown, ${compactionCoverage.tokenBudgetMissingPages} token-budget missing, and ${compactionCoverage.otherMissingPages} other missing page${compactionCoverage.otherMissingPages === 1 ? "" : "s"} across compactable docs pages.` + (compactConfigured ? " agent.compact defaults are configured." : " No agent.compact defaults were found in docs config."), compactionResult.recommendation));
|
|
1493
|
+
const averageMetric = (values) => values.length === 0 ? 0 : Math.round(values.reduce((total, value) => total + value, 0) / values.length * 100) / 100;
|
|
1494
|
+
const proportionalEvaluationScore = evaluations.score === null ? 0 : Math.round(evaluations.score / 100 * 15);
|
|
1495
|
+
const evaluationScore = evaluations.status === "failed" ? Math.min(14, proportionalEvaluationScore) : proportionalEvaluationScore;
|
|
1496
|
+
checks.push(makeCheck("golden-tasks", "Golden agent tasks", evaluations.status === "passed" ? "pass" : evaluations.status === "failed" ? "fail" : "warn", evaluationScore, 15, evaluations.status === "unmeasured" ? "No golden agent tasks are configured; retrieval usefulness is unmeasured." : `${evaluations.passedTaskCount}/${evaluations.taskCount} golden tasks passed with ${evaluations.score}/100 average score, ${averageMetric(evaluations.tasks.map((task) => task.retrieval.recallAtK))} retrieval recall, ${averageMetric(evaluations.tasks.map((task) => task.citations.recall))} citation recall, and ${evaluations.tasks.reduce((total, task) => total + task.usage.usedUtf8Bytes, 0)} UTF-8 context bytes used.`, evaluations.status === "passed" ? void 0 : evaluations.status === "unmeasured" ? "Configure agent.evaluations.tasks so doctor and review can measure retrieval, citations, framework/version selection, executable examples, and token usage." : "Inspect the failed golden task metrics and fix retrieval ranking, citations, applicability metadata, examples, or context budgets."));
|
|
1383
1497
|
const hosted = options.url ? await buildHostedAgentChecks(options.url, pages) : void 0;
|
|
1384
1498
|
if (hosted) checks.push(...hosted.checks);
|
|
1385
1499
|
const { score, maxScore } = normalizedDoctorScore(checks.reduce((total, check) => total + check.score, 0), checks.reduce((total, check) => total + check.maxScore, 0));
|
|
@@ -1392,9 +1506,11 @@ async function inspectAgentReadiness(options = {}) {
|
|
|
1392
1506
|
url: hosted?.baseUrl,
|
|
1393
1507
|
score,
|
|
1394
1508
|
maxScore,
|
|
1395
|
-
grade: gradeForAgentScore(score),
|
|
1509
|
+
grade: gradeForAgentScore(score, checks),
|
|
1396
1510
|
checks,
|
|
1397
1511
|
coverage,
|
|
1512
|
+
usefulness: usefulness.metrics,
|
|
1513
|
+
evaluations,
|
|
1398
1514
|
recommendations: checks.map((check) => check.recommendation).filter((recommendation) => Boolean(recommendation)).slice(0, 3)
|
|
1399
1515
|
};
|
|
1400
1516
|
}
|
|
@@ -1428,8 +1544,8 @@ async function inspectHumanReadiness(options = {}) {
|
|
|
1428
1544
|
};
|
|
1429
1545
|
}
|
|
1430
1546
|
const configContent = readFileSync(configPath, "utf-8");
|
|
1431
|
-
const
|
|
1432
|
-
const config =
|
|
1547
|
+
const configLoad = await loadDocsConfigModuleResultWithProjectEnv(rootDir, options.configPath);
|
|
1548
|
+
const config = configLoad.status === "evaluated" ? configLoad.config : void 0;
|
|
1433
1549
|
const entry = config?.entry ?? readTopLevelStringProperty(configContent, "entry") ?? "docs";
|
|
1434
1550
|
const contentDir = config?.contentDir ?? resolveDocsContentDir(rootDir, configContent, entry);
|
|
1435
1551
|
const ordering = config?.ordering === "alphabetical" || config?.ordering === "numeric" || Array.isArray(config?.ordering) ? config.ordering : void 0;
|
|
@@ -1452,7 +1568,7 @@ async function inspectHumanReadiness(options = {}) {
|
|
|
1452
1568
|
const navigationCoverage = coverage.totalPages === 0 ? 0 : Math.min(100, Math.round(coverage.navigationPages / coverage.totalPages * 100));
|
|
1453
1569
|
const navigationResult = navigationScore(navigationCoverage);
|
|
1454
1570
|
const checks = [];
|
|
1455
|
-
checks.push(makeCheck("config", "Docs config", "pass", 10, 10,
|
|
1571
|
+
checks.push(makeCheck("config", "Docs config", configLoad.status === "evaluated" ? "pass" : "warn", configLoad.status === "evaluated" ? 10 : 2, 10, configLoad.status === "evaluated" ? `Resolved ${path.relative(rootDir, configLoad.path).replace(/\\/g, "/")} and evaluated the config module.` : `Resolved ${path.relative(rootDir, configPath).replace(/\\/g, "/")} using static parsing fallback. ${configLoad.error}`, configLoad.status === "evaluated" ? void 0 : "Fix docs.config module evaluation so the site score uses resolved dynamic configuration."));
|
|
1456
1572
|
const contentDirAbs = path.resolve(rootDir, contentDir);
|
|
1457
1573
|
checks.push(coverage.totalPages > 0 ? makeCheck("content", "Docs content", "pass", 15, 15, `Found ${coverage.totalPages} docs page${coverage.totalPages === 1 ? "" : "s"} in ${path.relative(rootDir, contentDirAbs).replace(/\\/g, "/")}.`) : makeCheck("content", "Docs content", "fail", 0, 15, `No folder-based docs pages were found in ${path.relative(rootDir, contentDirAbs).replace(/\\/g, "/")}.`, "Add index/page MDX files under the configured contentDir so the human docs site has pages to render."));
|
|
1458
1574
|
checks.push(makeCheck("navigation", "Navigation coverage", navigationResult.status, navigationResult.score, 15, coverage.totalPages > 0 ? `The generated docs navigation exposes ${coverage.navigationPages}/${coverage.totalPages} page entries (${navigationCoverage}% coverage).` : "No docs pages were available to score navigation coverage.", navigationCoverage >= 100 ? void 0 : "Make sure every important docs page is reachable from the generated navigation tree and not stranded outside the main docs flow."));
|
|
@@ -1485,6 +1601,8 @@ function printAgentDoctorReport(report) {
|
|
|
1485
1601
|
console.log(`${pc.bold("Framework:")} ${report.framework} ${pc.dim("•")} ${pc.bold("Entry:")} ${report.entry ?? "docs"} ${pc.dim("•")} ${pc.bold("Content:")} ${report.contentDir ?? "-"}`);
|
|
1486
1602
|
if (report.url) console.log(`${pc.bold("Hosted URL:")} ${report.url}`);
|
|
1487
1603
|
console.log(`${pc.bold("Explicit agent-friendly pages:")} ${report.coverage.explicitPages}/${report.coverage.totalPages} pages ${pc.dim(`(${report.coverage.explicitCoverage}%)`)}`);
|
|
1604
|
+
if (report.usefulness) console.log(`${pc.bold("Useful Agent blocks:")} ${report.usefulness.agentBlocks.useful}/${report.usefulness.agentBlocks.total} ${pc.dim(`• ${report.usefulness.taskCompleteness.completePages}/${report.usefulness.actionablePages} actionable pages task-complete`)}`);
|
|
1605
|
+
if (report.evaluations) console.log(`${pc.bold("Golden tasks:")} ${report.evaluations.status === "unmeasured" ? "unmeasured" : `${report.evaluations.passedTaskCount}/${report.evaluations.taskCount} passed (${report.evaluations.score}/100)`}`);
|
|
1488
1606
|
console.log(`${pc.bold("Generated agent.md freshness:")} ${report.coverage.compaction.freshGeneratedPages} fresh ${pc.dim("•")} ${report.coverage.compaction.staleGeneratedPages} stale ${pc.dim("•")} ${report.coverage.compaction.modifiedGeneratedPages} modified ${pc.dim("•")} ${report.coverage.compaction.tokenBudgetMissingPages} token-budget missing`);
|
|
1489
1607
|
if (report.fixes && report.fixes.length > 0) console.log(`${pc.bold("Fixes:")} ${report.fixes.map((fix) => `${fix.status === "applied" ? "applied" : "skipped"} ${fix.title}`).join(pc.dim(" • "))}`);
|
|
1490
1608
|
console.log();
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { c as fileExists, o as exec, s as execOutput } from "./utils-
|
|
2
|
-
import { a as getPackagesForFramework, c as resolveDocsPackageManager, l as validateUpgradeVersion, r as buildDocsPackageInstallCommand, s as resolveDocsPackageFramework } from "./package-version-
|
|
1
|
+
import { c as fileExists, o as exec, s as execOutput } from "./utils-DBCCkkJS.mjs";
|
|
2
|
+
import { a as getPackagesForFramework, c as resolveDocsPackageManager, l as validateUpgradeVersion, r as buildDocsPackageInstallCommand, s as resolveDocsPackageFramework } from "./package-version-DRIc08EU.mjs";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import path from "node:path";
|
|
5
5
|
import pc from "picocolors";
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { $ as
|
|
2
|
-
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, L as PromptProviderChoice, O as resolveDocsSitemapConfig, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-
|
|
1
|
+
import { $ as DocsFeedbackValue, $t as McpDocsSearchConfig, A as DocsAnalyticsSource, An as TypesenseDocsSearchConfig, At as DocsSearchDocument, B as DocsCloudFeatureConfig, Bt as DocsTelemetryEventInput, C as DocsAgentTraceEventType, Cn as SidebarFolderIndexBehavior, Ct as DocsRobotsConfig, D as DocsAnalyticsEventInput, Dn as SidebarTree, Dt as DocsSearchAdapterFactory, E as DocsAnalyticsEvent, En as SidebarPageNode, Et as DocsSearchAdapterContext, F as DocsAskAIFeedbackMessage, Ft as DocsSearchSourcePage, G as DocsCodeBlocksPlannerProvider, Gt as FeedbackConfig, H as DocsCloudPublishConfig, Ht as DocsTelemetryFeatures, I as DocsAskAIFeedbackValue, It as DocsSitemapConfig, J as DocsCodeBlocksValidateConfig, Jt as LastUpdatedConfig, K as DocsCodeBlocksRunnerConfig, Kt as FontStyle, L as DocsAskAIMcpConfig, Lt as DocsTelemetryAgentSurface, M as DocsAskAIActionType, Mn as UIConfig, Mt as DocsSearchQuery, N as DocsAskAIFeedbackConfig, Nt as DocsSearchResult, O as DocsAnalyticsEventType, On as SimpleDocsSearchConfig, Ot as DocsSearchChunkingConfig, P as DocsAskAIFeedbackData, Pt as DocsSearchResultType, Q as DocsFeedbackData, Qt as LlmsTxtSectionConfig, R as DocsCloudApiKeyConfig, Rt as DocsTelemetryConfig, S as DocsAgentTraceEventInput, Sn as SidebarConfig, St as DocsReviewSeverity, T as DocsAnalyticsConfig, Tn as SidebarNode, Tt as DocsSearchAdapter, U as DocsCodeBlocksConfig, Ut as DocsTelemetryFramework, V as DocsCloudPreviewConfig, Vt as DocsTelemetryEventType, W as DocsCodeBlocksPlannerConfig, Wt as DocsTheme, X as DocsCodeBlocksValidationPolicy, Xt as LlmsTxtMaxCharsConfig, Y as DocsCodeBlocksValidationMode, Yt as LlmsTxtConfig, Z as DocsConfig, Zt as LlmsTxtMaxCharsMode, _ as DocsAgentFeedbackData, _n as PageTwitter, _t as DocsReviewCiConfig, a as ApiReferenceRenderer, an as OpenDocsTarget, at as DocsMcpAuthenticateResult, b as DocsAgentGoldenTaskExpectation, bn as ResolvedDocsRelatedLink, bt as DocsReviewRulesConfig, c as ChangelogFrontmatter, cn as PageActionsConfig, ct as DocsMcpOriginContext, d as CopyMarkdownFormat, dn as PageAgentFailureMode, dt as DocsMetadata, en as OGConfig, et as DocsI18nConfig, f as CustomDocsSearchConfig, fn as PageAgentFrontmatter, ft as DocsNav, g as DocsAgentFeedbackContext, gn as PageSidebarFrontmatter, gt as DocsRelatedItem, h as DocsAgentEvaluationsConfig, hn as PageOpenGraph, ht as DocsObservabilityEventInput, i as ApiReferenceConfig, in as OpenDocsProviderId, it as DocsMcpAuthenticateContext, j as DocsAskAIActionData, jn as TypographyConfig, jt as DocsSearchEmbeddingsConfig, k as DocsAnalyticsInput, kn as ThemeToggleConfig, kt as DocsSearchConfig, l as CodeBlockCopyData, ln as PageAgentAppliesTo, lt as DocsMcpSecurityConfig, m as DocsAgentConfig, mn as PageFrontmatter, mt as DocsObservabilityEvent, n as AgentFeedbackConfig, nn as OpenDocsProvider, nt as DocsMcpAuthPrincipal, o as BreadcrumbConfig, on as OpenGraphImage, ot as DocsMcpConfig, p as DocsAgentCompactConfig, pn as PageAgentVerification, pt as DocsObservabilityConfig, q as DocsCodeBlocksRunnerProvider, qt as GithubConfig, r as AlgoliaDocsSearchConfig, rn as OpenDocsProviderConfig, rt as DocsMcpAuthenticate, s as ChangelogConfig, sn as OrderingItem, st as DocsMcpCorsConfig, t as AIConfig, tn as OpenDocsConfig, tt as DocsMcpAllowedOrigins, u as CopyMarkdownConfig, un as PageAgentCommand, ut as DocsMcpToolsConfig, v as DocsAgentGoldenExpectedExample, vn as ReadingTimeConfig, vt as DocsReviewCiMode, w as DocsAgentTraceStatus, wn as SidebarFolderNode, wt as DocsRobotsRule, x as DocsAgentGoldenTaskFilters, xn as SidebarComponentProps, xt as DocsReviewScoreConfig, y as DocsAgentGoldenTask, yn as ReadingTimeFormat, yt as DocsReviewConfig, z as DocsCloudConfig, zt as DocsTelemetryEvent } from "./types-BVgucdVm.mjs";
|
|
2
|
+
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, L as PromptProviderChoice, O as resolveDocsSitemapConfig, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-CfWvmVYA.mjs";
|
|
3
3
|
import { DocsMcpPage, DocsMcpResolvedConfig } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/define-docs.d.ts
|
|
@@ -261,6 +261,25 @@ interface PageAgentFrontmatterIssue {
|
|
|
261
261
|
path: string;
|
|
262
262
|
message: string;
|
|
263
263
|
}
|
|
264
|
+
declare const PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS: readonly ["task", "outcome", "appliesTo", "prerequisites", "files", "commands", "sideEffects", "verification", "rollback", "failureModes"];
|
|
265
|
+
declare const PAGE_AGENT_CONTRACT_FIELDS: readonly ["tokenBudget", "task", "outcome", "appliesTo", "prerequisites", "files", "commands", "sideEffects", "verification", "rollback", "failureModes"];
|
|
266
|
+
declare const PAGE_AGENT_CONTRACT_FIELD_SCHEMA: {
|
|
267
|
+
readonly tokenBudget: "number";
|
|
268
|
+
readonly task: "string";
|
|
269
|
+
readonly outcome: "string";
|
|
270
|
+
readonly appliesTo: {
|
|
271
|
+
readonly framework: "string|string[]";
|
|
272
|
+
readonly version: "string|string[]";
|
|
273
|
+
readonly package: "string|string[]";
|
|
274
|
+
};
|
|
275
|
+
readonly prerequisites: "string[]";
|
|
276
|
+
readonly files: "string[]";
|
|
277
|
+
readonly commands: "Array<string|{run,cwd?,description?}>";
|
|
278
|
+
readonly sideEffects: "string[]";
|
|
279
|
+
readonly verification: "Array<string|{description?,run?,expect?}>";
|
|
280
|
+
readonly rollback: "string[]";
|
|
281
|
+
readonly failureModes: "Array<string|{symptom,resolution?}>";
|
|
282
|
+
};
|
|
264
283
|
declare const PAGE_AGENT_CONTRACT_START_MARKER = "<!-- farming-labs:agent-contract:start -->";
|
|
265
284
|
declare const PAGE_AGENT_CONTRACT_END_MARKER = "<!-- farming-labs:agent-contract:end -->";
|
|
266
285
|
/**
|
|
@@ -794,21 +813,21 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
794
813
|
agentContract: {
|
|
795
814
|
usefulContractFields: string[];
|
|
796
815
|
fields: {
|
|
797
|
-
tokenBudget:
|
|
798
|
-
task: string;
|
|
799
|
-
outcome: string;
|
|
800
|
-
appliesTo: {
|
|
801
|
-
framework: string;
|
|
802
|
-
version: string;
|
|
803
|
-
package: string;
|
|
816
|
+
readonly tokenBudget: "number";
|
|
817
|
+
readonly task: "string";
|
|
818
|
+
readonly outcome: "string";
|
|
819
|
+
readonly appliesTo: {
|
|
820
|
+
readonly framework: "string|string[]";
|
|
821
|
+
readonly version: "string|string[]";
|
|
822
|
+
readonly package: "string|string[]";
|
|
804
823
|
};
|
|
805
|
-
prerequisites: string;
|
|
806
|
-
files: string;
|
|
807
|
-
commands: string;
|
|
808
|
-
sideEffects: string;
|
|
809
|
-
verification: string;
|
|
810
|
-
rollback: string;
|
|
811
|
-
failureModes: string;
|
|
824
|
+
readonly prerequisites: "string[]";
|
|
825
|
+
readonly files: "string[]";
|
|
826
|
+
readonly commands: "Array<string|{run,cwd?,description?}>";
|
|
827
|
+
readonly sideEffects: "string[]";
|
|
828
|
+
readonly verification: "Array<string|{description?,run?,expect?}>";
|
|
829
|
+
readonly rollback: "string[]";
|
|
830
|
+
readonly failureModes: "Array<string|{symptom,resolution?}>";
|
|
812
831
|
};
|
|
813
832
|
mcpTools?: DocsAgentContractMcpTools | undefined;
|
|
814
833
|
enabled: boolean;
|
|
@@ -991,4 +1010,4 @@ declare function renderDocsRobotsGeneratedBlock(options?: DocsRobotsRenderOption
|
|
|
991
1010
|
declare function upsertDocsRobotsGeneratedBlock(existing: string, block: string): string;
|
|
992
1011
|
declare function analyzeDocsRobotsTxt(content: string, options?: DocsRobotsRenderOptions): DocsRobotsAnalysis;
|
|
993
1012
|
//#endregion
|
|
994
|
-
export { type AIConfig, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CopyMarkdownFormat, type CustomDocsSearchConfig, DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_CONTRACT_VERSION, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, type DocsAgentAdapter, type DocsAgentConformanceCaseResult, type DocsAgentConformanceReport, type DocsAgentContractCase, type DocsAgentContractExpectation, type DocsAgentContractMcpTools, type DocsAgentContractRequest, type DocsAgentContractSurface, type DocsAgentDiscoverySpecOptions, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsAgentFeedbackDiscoveryConfig, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAgentsDocumentOptions, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAnalyticsEventType, type DocsAnalyticsInput, type DocsAnalyticsSource, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudApiKeyConfig, type DocsCloudConfig, type DocsCloudFeatureConfig, type DocsCloudPreviewConfig, type DocsCloudPublishConfig, type DocsCodeBlocksConfig, type DocsCodeBlocksPlannerConfig, type DocsCodeBlocksPlannerProvider, type DocsCodeBlocksRunnerConfig, type DocsCodeBlocksRunnerProvider, type DocsCodeBlocksValidateConfig, type DocsCodeBlocksValidationMode, type DocsCodeBlocksValidationPolicy, type DocsConfig, type DocsConfigMap, type DocsConfigMapJsonValue, type DocsConfigMapPointer, type DocsDiagnostics, type DocsDiagnosticsFeature, type DocsDiagnosticsIssue, type DocsDiagnosticsIssueSeverity, type DocsDiagnosticsOptions, type DocsDiagnosticsStatus, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsLlmsDiscoveryConfig, type DocsLlmsTxtGeneratedContent, type DocsLlmsTxtGeneratedSection, type DocsLlmsTxtMaxCharsIssue, type DocsLlmsTxtPageInput, type DocsLlmsTxtRequest, type DocsLlmsTxtResolvedMaxChars, type DocsLlmsTxtResolvedSection, type DocsLlmsTxtSelectedContent, type DocsMarkdownAgentDetection, type DocsMarkdownPage, type DocsMarkdownRecoveryMatch, type DocsMarkdownRecoveryResult, type DocsMarkdownResponseOptions, type DocsMcpAllowedOrigins, type DocsMcpAuthPrincipal, type DocsMcpAuthenticate, type DocsMcpAuthenticateContext, type DocsMcpAuthenticateResult, type DocsMcpConfig, type DocsMcpCorsConfig, type DocsMcpEndpointCandidate, type DocsMcpEndpointCandidateOptions, type DocsMcpOriginContext, type DocsMcpSecurityConfig, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOpenApiDiscoveryConfig, type DocsOpenApiResolvedDiscoveryConfig, type DocsPageStructuredDataInput, type DocsPathMatch, type DocsRelatedItem, type DocsReviewCiConfig, type DocsReviewCiMode, type DocsReviewConfig, type DocsReviewRulesConfig, type DocsReviewScoreConfig, type DocsReviewSeverity, type DocsRobotsConfig, type DocsRobotsRenderOptions, type DocsRobotsResolvedConfig, type DocsRobotsRule, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchQuery, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsSitemapConfig, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type DocsSkillDocumentOptions, type DocsStructuredDataBreadcrumb, type DocsTelemetryAgentSurface, type DocsTelemetryAgentSurfaceContext, type DocsTelemetryAgentSurfaceRequestOptions, type DocsTelemetryConfig, type DocsTelemetryContext, type DocsTelemetryEvent, type DocsTelemetryEventInput, type DocsTelemetryEventType, type DocsTelemetryFeatures, type DocsTelemetryFramework, type DocsTheme, type FeedbackConfig, type FontStyle, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, type GeneratedAgentProvenance, type GeneratedAgentSourceKind, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type LlmsTxtMaxCharsConfig, type LlmsTxtMaxCharsMode, type LlmsTxtSectionConfig, type McpDocsSearchConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenDocsProviderConfig, type OpenDocsProviderId, type OpenDocsTarget, type OpenGraphImage, type OrderingItem, PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_START_MARKER, type PageActionsConfig, type PageAgentAppliesTo, type PageAgentCommand, type PageAgentFailureMode, type PageAgentFrontmatter, type PageAgentFrontmatterIssue, type PageAgentVerification, type PageFrontmatter, type PageOpenGraph, type PageSidebarFrontmatter, type PageTwitter, type PromptAction, type PromptProviderChoice, type ReadingTimeConfig, type ReadingTimeFormat, type ResolvedChangelogConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsI18n, type ResolvedDocsObservabilityConfig, type ResolvedDocsRelatedLink, type ResolvedDocsTelemetryConfig, type RunDocsAgentConformanceOptions, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, type SidebarComponentProps, type SidebarConfig, type SidebarFolderIndexBehavior, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type SimpleDocsSearchConfig, type ThemeToggleConfig, type TypesenseDocsSearchConfig, type TypographyConfig, type UIConfig, acceptsDocsMarkdown, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasStructuredPageAgentContract, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload };
|
|
1013
|
+
export { type AIConfig, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CopyMarkdownFormat, type CustomDocsSearchConfig, DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_CONTRACT_VERSION, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, type DocsAgentAdapter, type DocsAgentCompactConfig, type DocsAgentConfig, type DocsAgentConformanceCaseResult, type DocsAgentConformanceReport, type DocsAgentContractCase, type DocsAgentContractExpectation, type DocsAgentContractMcpTools, type DocsAgentContractRequest, type DocsAgentContractSurface, type DocsAgentDiscoverySpecOptions, type DocsAgentEvaluationsConfig, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsAgentFeedbackDiscoveryConfig, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentGoldenExpectedExample, type DocsAgentGoldenTask, type DocsAgentGoldenTaskExpectation, type DocsAgentGoldenTaskFilters, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAgentsDocumentOptions, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAnalyticsEventType, type DocsAnalyticsInput, type DocsAnalyticsSource, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudApiKeyConfig, type DocsCloudConfig, type DocsCloudFeatureConfig, type DocsCloudPreviewConfig, type DocsCloudPublishConfig, type DocsCodeBlocksConfig, type DocsCodeBlocksPlannerConfig, type DocsCodeBlocksPlannerProvider, type DocsCodeBlocksRunnerConfig, type DocsCodeBlocksRunnerProvider, type DocsCodeBlocksValidateConfig, type DocsCodeBlocksValidationMode, type DocsCodeBlocksValidationPolicy, type DocsConfig, type DocsConfigMap, type DocsConfigMapJsonValue, type DocsConfigMapPointer, type DocsDiagnostics, type DocsDiagnosticsFeature, type DocsDiagnosticsIssue, type DocsDiagnosticsIssueSeverity, type DocsDiagnosticsOptions, type DocsDiagnosticsStatus, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsLlmsDiscoveryConfig, type DocsLlmsTxtGeneratedContent, type DocsLlmsTxtGeneratedSection, type DocsLlmsTxtMaxCharsIssue, type DocsLlmsTxtPageInput, type DocsLlmsTxtRequest, type DocsLlmsTxtResolvedMaxChars, type DocsLlmsTxtResolvedSection, type DocsLlmsTxtSelectedContent, type DocsMarkdownAgentDetection, type DocsMarkdownPage, type DocsMarkdownRecoveryMatch, type DocsMarkdownRecoveryResult, type DocsMarkdownResponseOptions, type DocsMcpAllowedOrigins, type DocsMcpAuthPrincipal, type DocsMcpAuthenticate, type DocsMcpAuthenticateContext, type DocsMcpAuthenticateResult, type DocsMcpConfig, type DocsMcpCorsConfig, type DocsMcpEndpointCandidate, type DocsMcpEndpointCandidateOptions, type DocsMcpOriginContext, type DocsMcpSecurityConfig, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOpenApiDiscoveryConfig, type DocsOpenApiResolvedDiscoveryConfig, type DocsPageStructuredDataInput, type DocsPathMatch, type DocsRelatedItem, type DocsReviewCiConfig, type DocsReviewCiMode, type DocsReviewConfig, type DocsReviewRulesConfig, type DocsReviewScoreConfig, type DocsReviewSeverity, type DocsRobotsConfig, type DocsRobotsRenderOptions, type DocsRobotsResolvedConfig, type DocsRobotsRule, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchQuery, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsSitemapConfig, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type DocsSkillDocumentOptions, type DocsStructuredDataBreadcrumb, type DocsTelemetryAgentSurface, type DocsTelemetryAgentSurfaceContext, type DocsTelemetryAgentSurfaceRequestOptions, type DocsTelemetryConfig, type DocsTelemetryContext, type DocsTelemetryEvent, type DocsTelemetryEventInput, type DocsTelemetryEventType, type DocsTelemetryFeatures, type DocsTelemetryFramework, type DocsTheme, type FeedbackConfig, type FontStyle, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, type GeneratedAgentProvenance, type GeneratedAgentSourceKind, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type LlmsTxtMaxCharsConfig, type LlmsTxtMaxCharsMode, type LlmsTxtSectionConfig, type McpDocsSearchConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenDocsProviderConfig, type OpenDocsProviderId, type OpenDocsTarget, type OpenGraphImage, type OrderingItem, PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_FIELDS, PAGE_AGENT_CONTRACT_FIELD_SCHEMA, PAGE_AGENT_CONTRACT_START_MARKER, PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS, type PageActionsConfig, type PageAgentAppliesTo, type PageAgentCommand, type PageAgentFailureMode, type PageAgentFrontmatter, type PageAgentFrontmatterIssue, type PageAgentVerification, type PageFrontmatter, type PageOpenGraph, type PageSidebarFrontmatter, type PageTwitter, type PromptAction, type PromptProviderChoice, type ReadingTimeConfig, type ReadingTimeFormat, type ResolvedChangelogConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsI18n, type ResolvedDocsObservabilityConfig, type ResolvedDocsRelatedLink, type ResolvedDocsTelemetryConfig, type RunDocsAgentConformanceOptions, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, type SidebarComponentProps, type SidebarConfig, type SidebarFolderIndexBehavior, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type SimpleDocsSearchConfig, type ThemeToggleConfig, type TypesenseDocsSearchConfig, type TypographyConfig, type UIConfig, acceptsDocsMarkdown, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasStructuredPageAgentContract, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload };
|
package/dist/index.mjs
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
import { _ as extendTheme, a as resolveReadingTimeOptions, b as defineDocs, c as buildPageTwitter, d as resolveOGImage, f as resolveTitle, g as createTheme, h as runDocsAgentConformance, i as resolveReadingTimeFromSource, l as renderDocsPageStructuredDataJson, m as createDocsAgentContractCases, n as resolvePageReadingTime, o as buildDocsPageStructuredData, p as DOCS_AGENT_CONTRACT_VERSION, r as resolveReadingTimeFromContent, s as buildPageOpenGraph, t as estimateReadingTimeMinutes, u as resolveDocsMetadataBaseUrl, v as deepMerge, y as resolveChangelogConfig } from "./reading-time-
|
|
2
|
-
import { a as emitDocsAnalyticsEvent, c as resolveDocsAnalyticsConfig, i as emitDocsAgentTraceEvent, l as resolveDocsObservabilityConfig, n as createDocsAgentTraceContext, o as emitDocsObservabilityEvent, r as createDocsAgentTraceId, s as getDocsRequestAnalyticsProperties, t as DOCS_AGENT_TRACE_EVENT_TYPES } from "./analytics-
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import { A as getDocsTelemetryFeatures, C as resolvePageSidebarFolderIndexBehavior, D as emitDocsTelemetryEvent, E as emitDocsTelemetryAgentSurfaceEvent, M as resolveDocsTelemetryConfig, O as emitDocsTelemetryMcpToolEvent, S as applySidebarFolderIndexBehavior, T as resolveSidebarFolderIndexBehaviorForPath, _ as hashGeneratedAgentContent, a as createMcpSearchAdapter, b as serializeGeneratedAgentDocument, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, g as GENERATED_AGENT_PROVENANCE_VERSION, h as GENERATED_AGENT_PROVENANCE_MARKER, i as createCustomSearchAdapter, j as inferDocsTelemetryAgentSurface, k as emitDocsTelemetryProjectEvent, l as inferDocsAskAIPackageHints, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch, v as normalizeGeneratedAgentContent, w as resolveSidebarFolderIndexBehavior, x as stripGeneratedAgentProvenance, y as parseGeneratedAgentDocument } from "./search-CJNLkdjX.mjs";
|
|
1
|
+
import { _ as extendTheme, a as resolveReadingTimeOptions, b as defineDocs, c as buildPageTwitter, d as resolveOGImage, f as resolveTitle, g as createTheme, h as runDocsAgentConformance, i as resolveReadingTimeFromSource, l as renderDocsPageStructuredDataJson, m as createDocsAgentContractCases, n as resolvePageReadingTime, o as buildDocsPageStructuredData, p as DOCS_AGENT_CONTRACT_VERSION, r as resolveReadingTimeFromContent, s as buildPageOpenGraph, t as estimateReadingTimeMinutes, u as resolveDocsMetadataBaseUrl, v as deepMerge, y as resolveChangelogConfig } from "./reading-time-BrTd3DIh.mjs";
|
|
2
|
+
import { a as emitDocsAnalyticsEvent, c as resolveDocsAnalyticsConfig, i as emitDocsAgentTraceEvent, l as resolveDocsObservabilityConfig, n as createDocsAgentTraceContext, o as emitDocsObservabilityEvent, r as createDocsAgentTraceId, s as getDocsRequestAnalyticsProperties, t as DOCS_AGENT_TRACE_EVENT_TYPES } from "./analytics-Bx44lg6d.mjs";
|
|
3
|
+
import { $ as normalizeDocsPathSegment, A as DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, At as readDocsSitemapManifestFromContentMap, B as getDocsLlmsTxtMaxCharsIssue, Bt as PAGE_AGENT_CONTRACT_FIELDS, C as DEFAULT_OPENAPI_SCHEMA_ROUTE, Ct as DEFAULT_SITEMAP_MANIFEST_PATH, D as DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, Dt as DEFAULT_SITEMAP_XML_ROUTE, E as DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, Et as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, F as buildDocsDiagnostics, Ft as resolveDocsSitemapRequest, G as isDocsAgentsRequest, Gt as hasStructuredPageAgentContract, H as getDocsMarkdownVaryHeader, Ht as PAGE_AGENT_CONTRACT_START_MARKER, I as buildDocsMcpEndpointCandidates, It as toDocsSitemapMarkdownUrl, J as isDocsLlmsTxtPublicRequest, Jt as renderPageAgentFrontmatterYamlLines, K as isDocsConfigRequest, Kt as normalizePageAgentFrontmatter, L as createDocsMarkdownResponse, Lt as normalizeDocsRelated, M as buildDocsAgentDiscoverySpec, Mt as renderDocsSitemapXml, N as buildDocsAgentFeedbackSchema, Nt as resolveDocsSitemapConfig, Ot as buildDocsSitemapManifest, P as buildDocsConfigMap, Pt as resolveDocsSitemapPageLastmod, Q as matchesDocsLlmsTxtSection, R as detectDocsMarkdownAgentRequest, Rt as renderDocsRelatedMarkdownLines, S as DEFAULT_MCP_WELL_KNOWN_ROUTE, St as validateDocsAgentFeedbackPayload, T as DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, Tt as DEFAULT_SITEMAP_MD_ROUTE, U as hasDocsMarkdownSignatureAgent, Ut as PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS, V as getDocsMarkdownCanonicalLinkHeader, Vt as PAGE_AGENT_CONTRACT_FIELD_SCHEMA, W as isDocsAgentDiscoveryRequest, Wt as getPageAgentFrontmatterIssues, X as isDocsPublicGetRequest, Xt as upsertPageAgentContractMarkdown, Y as isDocsMcpRequest, Yt as stripGeneratedPageAgentContractMarkdown, Z as isDocsSkillRequest, _ as DEFAULT_LLMS_TXT_MAX_CHARS, _t as resolveDocsMarkdownRequest, a as DEFAULT_AGENT_MD_ROUTE, at as renderDocsMarkdownNotFound, b as DEFAULT_MCP_PUBLIC_ROUTE, bt as selectDocsLlmsTxtContent, c as DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, ct as resolveDocsAgentFeedbackConfig, d as DEFAULT_DOCS_CONFIG_FORMAT, dt as resolveDocsAgentsFormat, et as normalizeDocsUrlPath, f as DEFAULT_DOCS_CONFIG_ROUTE, ft as resolveDocsLlmsTxtFormat, g as DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, gt as resolveDocsMarkdownRecovery, h as DEFAULT_LLMS_FULL_TXT_ROUTE, ht as resolveDocsMarkdownCanonicalUrl, i as DEFAULT_AGENT_FEEDBACK_ROUTE, it as renderDocsMarkdownDocument, j as acceptsDocsMarkdown, jt as renderDocsSitemapMarkdown, k as DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, kt as createDocsSitemapResponse, l as DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, lt as resolveDocsAgentFeedbackRequest, m as DEFAULT_DOCS_DIAGNOSTICS_ROUTE, mt as resolveDocsLlmsTxtSections, n as DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, nt as renderDocsAgentsDocument, o as DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, ot as renderDocsSkillDocument, p as DEFAULT_DOCS_DIAGNOSTICS_FORMAT, pt as resolveDocsLlmsTxtRequest, q as isDocsDiagnosticsRequest, qt as renderPageAgentContractMarkdown, r as DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, rt as renderDocsLlmsTxt, s as DEFAULT_AGENT_SPEC_ROUTE, st as resolveDocsAgentContractMcpTools, t as DEFAULT_AGENTS_MD_ROUTE, tt as parseDocsAgentFeedbackData, u as DEFAULT_DOCS_API_ROUTE, ut as resolveDocsAgentMdxContent, v as DEFAULT_LLMS_TXT_ROUTE, vt as resolveDocsOpenApiDiscoveryConfig, w as DEFAULT_SKILL_MD_ROUTE, wt as DEFAULT_SITEMAP_MD_DOCS_ROUTE, x as DEFAULT_MCP_ROUTE, xt as toDocsMarkdownUrl, y as DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, yt as resolveDocsSkillFormat, z as findDocsMarkdownPage, zt as PAGE_AGENT_CONTRACT_END_MARKER } from "./agent-DXkXi-pS.mjs";
|
|
4
|
+
import { A as getDocsTelemetryFeatures, C as resolvePageSidebarFolderIndexBehavior, D as emitDocsTelemetryEvent, E as emitDocsTelemetryAgentSurfaceEvent, M as resolveDocsTelemetryConfig, O as emitDocsTelemetryMcpToolEvent, S as applySidebarFolderIndexBehavior, T as resolveSidebarFolderIndexBehaviorForPath, _ as hashGeneratedAgentContent, a as createMcpSearchAdapter, b as serializeGeneratedAgentDocument, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, g as GENERATED_AGENT_PROVENANCE_VERSION, h as GENERATED_AGENT_PROVENANCE_MARKER, i as createCustomSearchAdapter, j as inferDocsTelemetryAgentSurface, k as emitDocsTelemetryProjectEvent, l as inferDocsAskAIPackageHints, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch, v as normalizeGeneratedAgentContent, w as resolveSidebarFolderIndexBehavior, x as stripGeneratedAgentProvenance, y as parseGeneratedAgentDocument } from "./search-CJIC1Cqo.mjs";
|
|
6
5
|
import { n as resolveDocsLocale, r as resolveDocsPath, t as resolveDocsI18n } from "./i18n-CAlj1ADU.mjs";
|
|
7
|
-
import { a as analyzeDocsRobotsTxt, c as renderDocsRobotsGeneratedBlock, d as resolveDocsRobotsRequest, f as upsertDocsRobotsGeneratedBlock, i as DOCS_ROBOTS_GENERATED_BLOCK_START, l as renderDocsRobotsTxt, n as DEFAULT_ROBOTS_TXT_ROUTE, o as createDocsRobotsResponse, r as DOCS_ROBOTS_GENERATED_BLOCK_END, s as getDocsRobotsAllowRoutes, t as DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, u as resolveDocsRobotsConfig } from "./robots-
|
|
6
|
+
import { a as analyzeDocsRobotsTxt, c as renderDocsRobotsGeneratedBlock, d as resolveDocsRobotsRequest, f as upsertDocsRobotsGeneratedBlock, i as DOCS_ROBOTS_GENERATED_BLOCK_START, l as renderDocsRobotsTxt, n as DEFAULT_ROBOTS_TXT_ROUTE, o as createDocsRobotsResponse, r as DOCS_ROBOTS_GENERATED_BLOCK_END, s as getDocsRobotsAllowRoutes, t as DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, u as resolveDocsRobotsConfig } from "./robots-DAptQnkx.mjs";
|
|
8
7
|
|
|
9
|
-
export { DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_CONTRACT_VERSION, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_START_MARKER, acceptsDocsMarkdown, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasStructuredPageAgentContract, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload };
|
|
8
|
+
export { DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_CONTRACT_VERSION, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_FIELDS, PAGE_AGENT_CONTRACT_FIELD_SCHEMA, PAGE_AGENT_CONTRACT_START_MARKER, PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS, acceptsDocsMarkdown, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasStructuredPageAgentContract, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { a as devInstallCommand, c as fileExists, d as readFileSafe, f as spawnAndWaitFor, i as detectPackageManagerFromProject, l as formatPackageManagerDetection, n as detectGlobalCssFiles, o as exec, p as writeFileSafe, r as detectNextAppDir, t as detectFramework, u as installCommand } from "./utils-
|
|
2
|
-
import { $ as svelteDocsPublicHookTemplate, A as nextConfigMergedTemplate, B as nuxtServerApiDocsRouteTemplate, C as injectRootProviderIntoLayout, D as injectTanstackVitePlugins, E as injectTanstackRootProviderIntoRoute, F as nuxtDocsConfigTemplate, G as quickstartPageTemplate, H as nuxtServerDocsPublicMiddlewareTemplate, I as nuxtDocsPageTemplate, J as svelteDocsApiRouteTemplate, K as rootLayoutTemplate, L as nuxtGlobalCssTemplate, M as nextLocaleDocPageTemplate, N as nextLocalizedPageTemplate, O as installationPageTemplate, P as nuxtConfigTemplate, Q as svelteDocsPageTemplate, R as nuxtInstallationPageTemplate, S as injectNuxtCssImport, T as injectSvelteDocsPublicHook, U as nuxtWelcomePageTemplate, V as nuxtServerApiReferenceRouteTemplate, W as postcssConfigTemplate, X as svelteDocsLayoutServerTemplate, Y as svelteDocsConfigTemplate, Z as svelteDocsLayoutTemplate, _ as getAstroAdapterPkg, _t as tanstackViteConfigTemplate, a as astroDocsIndexTemplate, at as svelteWelcomePageTemplate, b as injectAstroDocsMiddleware, bt as welcomePageTemplate, c as astroDocsServerTemplate, ct as tanstackDocsCatchAllRouteTemplate, d as astroQuickstartPageTemplate, dt as tanstackDocsIndexRouteTemplate, et as svelteDocsServerTemplate, f as astroWelcomePageTemplate, ft as tanstackDocsPublicRouteTemplate, g as docsLayoutTemplate, gt as tanstackRootRouteTemplate, h as docsConfigTemplate, ht as tanstackQuickstartPageTemplate, i as astroDocsConfigTemplate, it as svelteRootLayoutTemplate, j as nextConfigTemplate, k as nextApiReferencePageTemplate, l as astroGlobalCssTemplate, lt as tanstackDocsConfigTemplate, m as customThemeTsTemplate, mt as tanstackInstallationPageTemplate, n as astroApiRouteTemplate, nt as svelteInstallationPageTemplate, o as astroDocsMiddlewareTemplate, ot as tanstackApiDocsRouteTemplate, p as customThemeCssTemplate, pt as tanstackDocsServerTemplate, q as svelteApiReferenceRouteTemplate, r as astroConfigTemplate, rt as svelteQuickstartPageTemplate, s as astroDocsPageTemplate, st as tanstackApiReferenceRouteTemplate, t as astroApiReferenceRouteTemplate, tt as svelteGlobalCssTemplate, u as astroInstallationPageTemplate, ut as tanstackDocsFunctionsTemplate, v as globalCssTemplate, vt as tanstackWelcomePageTemplate, w as injectSvelteCssImport, x as injectCssImport, y as injectAstroCssImport, yt as tsconfigTemplate, z as nuxtQuickstartPageTemplate } from "./templates-
|
|
1
|
+
import { a as devInstallCommand, c as fileExists, d as readFileSafe, f as spawnAndWaitFor, i as detectPackageManagerFromProject, l as formatPackageManagerDetection, n as detectGlobalCssFiles, o as exec, p as writeFileSafe, r as detectNextAppDir, t as detectFramework, u as installCommand } from "./utils-DBCCkkJS.mjs";
|
|
2
|
+
import { $ as svelteDocsPublicHookTemplate, A as nextConfigMergedTemplate, B as nuxtServerApiDocsRouteTemplate, C as injectRootProviderIntoLayout, D as injectTanstackVitePlugins, E as injectTanstackRootProviderIntoRoute, F as nuxtDocsConfigTemplate, G as quickstartPageTemplate, H as nuxtServerDocsPublicMiddlewareTemplate, I as nuxtDocsPageTemplate, J as svelteDocsApiRouteTemplate, K as rootLayoutTemplate, L as nuxtGlobalCssTemplate, M as nextLocaleDocPageTemplate, N as nextLocalizedPageTemplate, O as installationPageTemplate, P as nuxtConfigTemplate, Q as svelteDocsPageTemplate, R as nuxtInstallationPageTemplate, S as injectNuxtCssImport, T as injectSvelteDocsPublicHook, U as nuxtWelcomePageTemplate, V as nuxtServerApiReferenceRouteTemplate, W as postcssConfigTemplate, X as svelteDocsLayoutServerTemplate, Y as svelteDocsConfigTemplate, Z as svelteDocsLayoutTemplate, _ as getAstroAdapterPkg, _t as tanstackViteConfigTemplate, a as astroDocsIndexTemplate, at as svelteWelcomePageTemplate, b as injectAstroDocsMiddleware, bt as welcomePageTemplate, c as astroDocsServerTemplate, ct as tanstackDocsCatchAllRouteTemplate, d as astroQuickstartPageTemplate, dt as tanstackDocsIndexRouteTemplate, et as svelteDocsServerTemplate, f as astroWelcomePageTemplate, ft as tanstackDocsPublicRouteTemplate, g as docsLayoutTemplate, gt as tanstackRootRouteTemplate, h as docsConfigTemplate, ht as tanstackQuickstartPageTemplate, i as astroDocsConfigTemplate, it as svelteRootLayoutTemplate, j as nextConfigTemplate, k as nextApiReferencePageTemplate, l as astroGlobalCssTemplate, lt as tanstackDocsConfigTemplate, m as customThemeTsTemplate, mt as tanstackInstallationPageTemplate, n as astroApiRouteTemplate, nt as svelteInstallationPageTemplate, o as astroDocsMiddlewareTemplate, ot as tanstackApiDocsRouteTemplate, p as customThemeCssTemplate, pt as tanstackDocsServerTemplate, q as svelteApiReferenceRouteTemplate, r as astroConfigTemplate, rt as svelteQuickstartPageTemplate, s as astroDocsPageTemplate, st as tanstackApiReferenceRouteTemplate, t as astroApiReferenceRouteTemplate, tt as svelteGlobalCssTemplate, u as astroInstallationPageTemplate, ut as tanstackDocsFunctionsTemplate, v as globalCssTemplate, vt as tanstackWelcomePageTemplate, w as injectSvelteCssImport, x as injectCssImport, y as injectAstroCssImport, yt as tsconfigTemplate, z as nuxtQuickstartPageTemplate } from "./templates-1Cod8KrJ.mjs";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import path from "node:path";
|
|
5
5
|
import pc from "picocolors";
|
|
@@ -188,7 +188,7 @@ async function configureDocsCloudOnboarding(options) {
|
|
|
188
188
|
enabled = cloudAnswer;
|
|
189
189
|
}
|
|
190
190
|
if (!enabled) return;
|
|
191
|
-
const { initCloudConfig } = await import("./cloud-
|
|
191
|
+
const { initCloudConfig } = await import("./cloud-HWFlbfLJ.mjs");
|
|
192
192
|
printDocsCloudOnboardingInstructions(await initCloudConfig({
|
|
193
193
|
rootDir: options.rootDir,
|
|
194
194
|
configPath: getDocsCloudConfigPathForFramework(options.framework)
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import "./agent-
|
|
2
|
-
import "./
|
|
3
|
-
import "./
|
|
4
|
-
import "./
|
|
1
|
+
import "./agent-DXkXi-pS.mjs";
|
|
2
|
+
import "./search-CJIC1Cqo.mjs";
|
|
3
|
+
import "./sitemap-server-wsNLyVkb.mjs";
|
|
4
|
+
import "./agent-evals-BD17jOqL.mjs";
|
|
5
5
|
import { createFilesystemDocsMcpSource, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
|
|
6
|
+
import "./code-blocks-C9awWzEQ.mjs";
|
|
6
7
|
import "./server.mjs";
|
|
7
|
-
import {
|
|
8
|
+
import { d as readStringProperty, h as resolveDocsContentDir, l as readNavTitle, m as resolveDocsConfigPath, n as extractObjectLiteral, s as readBooleanProperty } from "./config-CydaZ5PB.mjs";
|
|
8
9
|
import { readFileSync } from "node:fs";
|
|
9
10
|
import pc from "picocolors";
|
|
10
11
|
|