@farming-labs/docs 0.2.53 → 0.2.55
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-BOOcHVDL.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-BYznnYed.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-BHzeeY45.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-CvRVnwdK.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-CNIPJdxN.mjs} +150 -32
- package/dist/{downgrade-Dj_KXV11.mjs → downgrade-BStNhyCc.mjs} +2 -2
- package/dist/index.d.mts +40 -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-F9zkBHrU.mjs} +6 -5
- package/dist/mcp.d.mts +22 -4
- package/dist/mcp.mjs +521 -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-Dlb8dRRx.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-CtAXkk_J.mjs → search-B8cF77_i.mjs} +6 -5
- package/dist/{search-CTu6Bvq-.d.mts → search-BnQKgDbk.d.mts} +1 -1
- package/dist/{search-CJNLkdjX.mjs → search-CEg1omHv.mjs} +54 -11
- package/dist/server.d.mts +108 -5
- package/dist/server.mjs +9 -9
- package/dist/{sitemap-OPb8EdNe.mjs → sitemap-D9ivTLm8.mjs} +8 -7
- package/dist/{sitemap-server-DnilMEiZ.mjs → sitemap-server-wsNLyVkb.mjs} +1 -1
- package/dist/{types-CdKu8KmO.d.mts → types-R-DN23yw.d.mts} +79 -2
- package/dist/{upgrade-BNdBB9tQ.mjs → upgrade-CXYRNV0C.mjs} +2 -2
- package/package.json +2 -2
- 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
package/dist/server.mjs
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
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-
|
|
2
|
-
import "./agent-
|
|
3
|
-
import {
|
|
4
|
-
import { a as
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import { n as isDocsCloudAskAIProvider, t as createDocsCloudAskAIResponse } from "./cloud-ask-ai-BFlx8VMO.mjs";
|
|
1
|
+
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";
|
|
2
|
+
import { At as readDocsSitemapManifestFromContentMap, Ct as DEFAULT_SITEMAP_MANIFEST_PATH, Dt as DEFAULT_SITEMAP_XML_ROUTE, Et as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, Ft as resolveDocsSitemapRequest, It as toDocsSitemapMarkdownUrl, Mt as renderDocsSitemapXml, Nt as resolveDocsSitemapConfig, Ot as buildDocsSitemapManifest, Pt as resolveDocsSitemapPageLastmod, Tt as DEFAULT_SITEMAP_MD_ROUTE, jt as renderDocsSitemapMarkdown, kt as createDocsSitemapResponse, wt as DEFAULT_SITEMAP_MD_DOCS_ROUTE } from "./agent-DXkXi-pS.mjs";
|
|
3
|
+
import { a as createMcpSearchAdapter, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, i as createCustomSearchAdapter, l as inferDocsAskAIPackageHints, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch } from "./search-CEg1omHv.mjs";
|
|
4
|
+
import { C as resolveApiReferenceOpenApiDiscovery, S as resolveApiReferenceConfig, T as remarkCodeGroup, _ as buildApiReferenceOpenApiDocument, a as DEFAULT_PROMPT_PROVIDER_TEMPLATES, b as buildApiReferenceScalarCss, c as resolvePromptProviderChoices, d as serializeDocsIconRegistry, f as serializeOpenDocsProvider, g as buildApiReferenceHtmlDocumentAsync, h as buildApiReferenceHtmlDocument, i as DEFAULT_OPEN_DOCS_TARGET, l as sanitizePromptText, m as DEFAULT_API_REFERENCE_OPENAPI_ROUTE, n as DEFAULT_OPEN_DOCS_PROMPT, o as normalizePromptProviderName, p as serializeOpenDocsProviders, r as DEFAULT_OPEN_DOCS_PROVIDER_IDS, s as parsePromptStringArray, t as readDocsSitemapManifest, u as serializeDocsIcon, v as buildApiReferenceOpenApiDocumentAsync, w as resolveApiReferenceRenderer, x as isApiReferenceOpenApiRequest, y as buildApiReferencePageTitle } from "./sitemap-server-wsNLyVkb.mjs";
|
|
5
|
+
import { a as buildDocsReviewWorkflowPathFilters, c as resolveDocsReviewConfig, i as buildDocsReviewWorkflow, n as DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD, o as ensureDocsReviewWorkflow, r as DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, s as readDocsReviewConfigFromSource, t as runDocsGoldenTasks } from "./agent-evals-BD17jOqL.mjs";
|
|
6
|
+
import { DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, DOCS_CONFIG_SCHEMA_OPTIONS, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, getDocsConfigSchema, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
|
|
7
|
+
import { n as isDocsCloudAskAIProvider, t as createDocsCloudAskAIResponse } from "./cloud-ask-ai-1k0q6OAH.mjs";
|
|
9
8
|
import { createDocsCloudRouteHandler, createDocsCloudServer } from "./docs-cloud-server.mjs";
|
|
9
|
+
import "./code-blocks-C9awWzEQ.mjs";
|
|
10
10
|
|
|
11
|
-
export { DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD, DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, DEFAULT_OPEN_DOCS_PROMPT, DEFAULT_OPEN_DOCS_PROVIDER_IDS, DEFAULT_OPEN_DOCS_TARGET, DEFAULT_PROMPT_PROVIDER_TEMPLATES, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsReviewWorkflow, buildDocsReviewWorkflowPathFilters, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAskAIResponse, createDocsCloudRouteHandler, createDocsCloudServer, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, ensureDocsReviewWorkflow, formatDocsAskAIPackageHints, getDocsRequestAnalyticsProperties, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, isDocsCloudAskAIProvider, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsReviewConfigFromSource, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, remarkCodeGroup, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsReviewConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };
|
|
11
|
+
export { DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD, DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, DEFAULT_OPEN_DOCS_PROMPT, DEFAULT_OPEN_DOCS_PROVIDER_IDS, DEFAULT_OPEN_DOCS_TARGET, DEFAULT_PROMPT_PROVIDER_TEMPLATES, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_CONFIG_SCHEMA_OPTIONS, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsReviewWorkflow, buildDocsReviewWorkflowPathFilters, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAskAIResponse, createDocsCloudRouteHandler, createDocsCloudServer, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, ensureDocsReviewWorkflow, formatDocsAskAIPackageHints, getDocsConfigSchema, getDocsRequestAnalyticsProperties, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, isDocsCloudAskAIProvider, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsReviewConfigFromSource, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, remarkCodeGroup, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsReviewConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsGoldenTasks, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };
|
|
@@ -1,15 +1,16 @@
|
|
|
1
|
-
import "./agent-
|
|
2
|
-
import
|
|
3
|
-
import "./
|
|
4
|
-
import "./
|
|
1
|
+
import { Mt as renderDocsSitemapXml, Nt as resolveDocsSitemapConfig, Ot as buildDocsSitemapManifest, jt as renderDocsSitemapMarkdown } from "./agent-DXkXi-pS.mjs";
|
|
2
|
+
import "./search-CEg1omHv.mjs";
|
|
3
|
+
import "./sitemap-server-wsNLyVkb.mjs";
|
|
4
|
+
import "./agent-evals-BD17jOqL.mjs";
|
|
5
5
|
import { createFilesystemDocsMcpSource } from "./mcp.mjs";
|
|
6
|
+
import "./code-blocks-C9awWzEQ.mjs";
|
|
6
7
|
import "./server.mjs";
|
|
7
|
-
import {
|
|
8
|
-
import { t as detectFramework } from "./utils-
|
|
8
|
+
import { d as readStringProperty, h as resolveDocsContentDir, i as loadDocsConfigModule, l as readNavTitle, m as resolveDocsConfigPath, p as readTopLevelStringProperty, s as readBooleanProperty, t as extractNestedObjectLiteral } from "./config-CydaZ5PB.mjs";
|
|
9
|
+
import { t as detectFramework } from "./utils-DBCCkkJS.mjs";
|
|
9
10
|
import { existsSync, mkdirSync, readFileSync, statSync, writeFileSync } from "node:fs";
|
|
10
11
|
import path from "node:path";
|
|
11
|
-
import pc from "picocolors";
|
|
12
12
|
import { execFileSync } from "node:child_process";
|
|
13
|
+
import pc from "picocolors";
|
|
13
14
|
|
|
14
15
|
//#region src/cli/sitemap.ts
|
|
15
16
|
function normalizePathSegment(value) {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Nt as resolveDocsSitemapConfig } from "./agent-DXkXi-pS.mjs";
|
|
2
2
|
import { createRequire } from "node:module";
|
|
3
3
|
import { existsSync, readFileSync, readdirSync, statSync } from "node:fs";
|
|
4
4
|
import path, { basename, join, relative } from "node:path";
|
|
@@ -832,7 +832,8 @@ interface DocsTelemetryConfig {
|
|
|
832
832
|
/**
|
|
833
833
|
* Public site origin to include in telemetry events.
|
|
834
834
|
*
|
|
835
|
-
* When omitted, the runtime request origin or deployment URL is used when available.
|
|
835
|
+
* When omitted, the runtime request origin or deployment URL is used when available. Localhost
|
|
836
|
+
* and loopback origins are ignored.
|
|
836
837
|
*/
|
|
837
838
|
siteOrigin?: string;
|
|
838
839
|
/**
|
|
@@ -2354,11 +2355,77 @@ interface DocsAgentCompactConfig {
|
|
|
2354
2355
|
*/
|
|
2355
2356
|
protectJson?: boolean;
|
|
2356
2357
|
}
|
|
2358
|
+
interface DocsAgentGoldenTaskFilters {
|
|
2359
|
+
/** Limit retrieval to a framework such as `nextjs`, `astro`, or `nuxt`. */
|
|
2360
|
+
framework?: string;
|
|
2361
|
+
/** Limit retrieval to an exact documented version. */
|
|
2362
|
+
version?: string;
|
|
2363
|
+
/** Limit retrieval to a locale. */
|
|
2364
|
+
locale?: string;
|
|
2365
|
+
}
|
|
2366
|
+
interface DocsAgentGoldenTaskExpectation {
|
|
2367
|
+
/** Canonical page or section URLs that should answer this task. */
|
|
2368
|
+
relevantSources: string[];
|
|
2369
|
+
/** Additional sources that may be cited without reducing precision. */
|
|
2370
|
+
allowedSources?: string[];
|
|
2371
|
+
/** Sources that must not be selected, for example an obsolete version. */
|
|
2372
|
+
forbiddenSources?: string[];
|
|
2373
|
+
/** Citations that must appear. Defaults to `relevantSources`. */
|
|
2374
|
+
requiredCitations?: string[];
|
|
2375
|
+
/** Minimum relevant-source recall in the top K results. Defaults to `1`. */
|
|
2376
|
+
minRecallAtK?: number;
|
|
2377
|
+
/** Maximum acceptable rank for the first relevant source. Defaults to `topK`. */
|
|
2378
|
+
maxFirstRelevantRank?: number;
|
|
2379
|
+
/** Runnable examples that must be found in retrieved context. */
|
|
2380
|
+
examples?: DocsAgentGoldenExpectedExample[];
|
|
2381
|
+
/** Minimum share of context bytes that must come from relevant sources. */
|
|
2382
|
+
minUsefulByteRatio?: number;
|
|
2383
|
+
}
|
|
2384
|
+
interface DocsAgentGoldenExpectedExample {
|
|
2385
|
+
/** Canonical page or section URL containing the example. */
|
|
2386
|
+
source?: string;
|
|
2387
|
+
language?: string;
|
|
2388
|
+
framework?: string;
|
|
2389
|
+
packageManager?: string;
|
|
2390
|
+
title?: string;
|
|
2391
|
+
/** Defaults to true. Set false for an intentionally non-runnable example. */
|
|
2392
|
+
runnable?: boolean;
|
|
2393
|
+
/** Literal fragments that must occur in the example. */
|
|
2394
|
+
includes?: string[];
|
|
2395
|
+
}
|
|
2396
|
+
interface DocsAgentGoldenTask {
|
|
2397
|
+
/** Stable identifier shown in doctor/review reports. */
|
|
2398
|
+
id: string;
|
|
2399
|
+
/** User-shaped retrieval query. */
|
|
2400
|
+
query: string;
|
|
2401
|
+
/** Optional retrieval scope. */
|
|
2402
|
+
filters?: DocsAgentGoldenTaskFilters;
|
|
2403
|
+
/** Conservative context budget. Uses the MCP context UTF-8 accounting strategy. */
|
|
2404
|
+
tokenBudget?: number;
|
|
2405
|
+
/** Number of ranked search results to evaluate. */
|
|
2406
|
+
topK?: number;
|
|
2407
|
+
/** Deterministic expectations used to score the task. */
|
|
2408
|
+
expect: DocsAgentGoldenTaskExpectation;
|
|
2409
|
+
}
|
|
2410
|
+
interface DocsAgentEvaluationsConfig {
|
|
2411
|
+
/** Enable deterministic golden-task evaluation. */
|
|
2412
|
+
enabled?: boolean;
|
|
2413
|
+
/** Default conservative context budget for tasks that omit `tokenBudget`. */
|
|
2414
|
+
tokenBudget?: number;
|
|
2415
|
+
/** Default retrieval depth for tasks that omit `topK`. */
|
|
2416
|
+
topK?: number;
|
|
2417
|
+
/** Golden tasks evaluated offline by `docs doctor` and `docs review`. */
|
|
2418
|
+
tasks?: DocsAgentGoldenTask[];
|
|
2419
|
+
}
|
|
2357
2420
|
interface DocsAgentConfig {
|
|
2358
2421
|
/**
|
|
2359
2422
|
* Defaults for `docs agent compact`.
|
|
2360
2423
|
*/
|
|
2361
2424
|
compact?: DocsAgentCompactConfig;
|
|
2425
|
+
/**
|
|
2426
|
+
* Deterministic retrieval, citation, version, example, and token-budget evaluations.
|
|
2427
|
+
*/
|
|
2428
|
+
evaluations?: boolean | DocsAgentEvaluationsConfig;
|
|
2362
2429
|
}
|
|
2363
2430
|
type DocsReviewSeverity = "off" | "suggestion" | "warn" | "error";
|
|
2364
2431
|
type DocsReviewCiMode = "off" | "warn" | "block";
|
|
@@ -2379,6 +2446,16 @@ interface DocsReviewRulesConfig {
|
|
|
2379
2446
|
runnableMetadata?: DocsReviewSeverity;
|
|
2380
2447
|
/** Validate structured page agent contracts and suggest context for implementation-heavy pages. */
|
|
2381
2448
|
agentContext?: DocsReviewSeverity;
|
|
2449
|
+
/** Statically validate commands referenced by agent contracts and runnable examples. */
|
|
2450
|
+
commandHealth?: DocsReviewSeverity;
|
|
2451
|
+
/** Require useful related-page coverage on actionable docs pages. */
|
|
2452
|
+
relatedCoverage?: DocsReviewSeverity;
|
|
2453
|
+
/** Report when docs.config could not be evaluated and only partial static parsing is available. */
|
|
2454
|
+
configConfidence?: DocsReviewSeverity;
|
|
2455
|
+
/** Detect disagreement between discovery, resolved config, and the public config schema. */
|
|
2456
|
+
agentSurfaceDrift?: DocsReviewSeverity;
|
|
2457
|
+
/** Run deterministic agent golden tasks and report failed or unmeasured behavior. */
|
|
2458
|
+
goldenTasks?: DocsReviewSeverity;
|
|
2382
2459
|
}
|
|
2383
2460
|
interface DocsReviewScoreConfig {
|
|
2384
2461
|
/**
|
|
@@ -3078,4 +3155,4 @@ interface DocsConfig {
|
|
|
3078
3155
|
og?: OGConfig;
|
|
3079
3156
|
}
|
|
3080
3157
|
//#endregion
|
|
3081
|
-
export {
|
|
3158
|
+
export { DocsFeedbackValue as $, McpDocsSearchConfig as $t, DocsAnalyticsSource as A, TypesenseDocsSearchConfig as An, DocsSearchDocument as At, DocsCloudFeatureConfig as B, DocsTelemetryEventInput as Bt, DocsAgentTraceEventType as C, SidebarFolderIndexBehavior as Cn, DocsRobotsConfig as Ct, DocsAnalyticsEventInput as D, SidebarTree as Dn, DocsSearchAdapterFactory as Dt, DocsAnalyticsEvent as E, SidebarPageNode as En, DocsSearchAdapterContext as Et, DocsAskAIFeedbackMessage as F, DocsSearchSourcePage as Ft, DocsCodeBlocksPlannerProvider as G, FeedbackConfig as Gt, DocsCloudPublishConfig as H, DocsTelemetryFeatures as Ht, DocsAskAIFeedbackValue as I, DocsSitemapConfig as It, DocsCodeBlocksValidateConfig as J, LastUpdatedConfig as Jt, DocsCodeBlocksRunnerConfig as K, FontStyle as Kt, DocsAskAIMcpConfig as L, DocsTelemetryAgentSurface as Lt, DocsAskAIActionType as M, UIConfig as Mn, DocsSearchQuery as Mt, DocsAskAIFeedbackConfig as N, DocsSearchResult as Nt, DocsAnalyticsEventType as O, SimpleDocsSearchConfig as On, DocsSearchChunkingConfig as Ot, DocsAskAIFeedbackData as P, DocsSearchResultType as Pt, DocsFeedbackData as Q, LlmsTxtSectionConfig as Qt, DocsCloudApiKeyConfig as R, DocsTelemetryConfig as Rt, DocsAgentTraceEventInput as S, SidebarConfig as Sn, DocsReviewSeverity as St, DocsAnalyticsConfig as T, SidebarNode as Tn, DocsSearchAdapter as Tt, DocsCodeBlocksConfig as U, DocsTelemetryFramework as Ut, DocsCloudPreviewConfig as V, DocsTelemetryEventType as Vt, DocsCodeBlocksPlannerConfig as W, DocsTheme as Wt, DocsCodeBlocksValidationPolicy as X, LlmsTxtMaxCharsConfig as Xt, DocsCodeBlocksValidationMode as Y, LlmsTxtConfig as Yt, DocsConfig as Z, LlmsTxtMaxCharsMode as Zt, DocsAgentFeedbackData as _, PageTwitter as _n, DocsReviewCiConfig as _t, ApiReferenceRenderer as a, OpenDocsTarget as an, DocsMcpAuthenticateResult as at, DocsAgentGoldenTaskExpectation as b, ResolvedDocsRelatedLink as bn, DocsReviewRulesConfig as bt, ChangelogFrontmatter as c, PageActionsConfig as cn, DocsMcpOriginContext as ct, CopyMarkdownFormat as d, PageAgentFailureMode as dn, DocsMetadata as dt, OGConfig as en, DocsI18nConfig as et, CustomDocsSearchConfig as f, PageAgentFrontmatter as fn, DocsNav as ft, DocsAgentFeedbackContext as g, PageSidebarFrontmatter as gn, DocsRelatedItem as gt, DocsAgentEvaluationsConfig as h, PageOpenGraph as hn, DocsObservabilityEventInput as ht, ApiReferenceConfig as i, OpenDocsProviderId as in, DocsMcpAuthenticateContext as it, DocsAskAIActionData as j, TypographyConfig as jn, DocsSearchEmbeddingsConfig as jt, DocsAnalyticsInput as k, ThemeToggleConfig as kn, DocsSearchConfig as kt, CodeBlockCopyData as l, PageAgentAppliesTo as ln, DocsMcpSecurityConfig as lt, DocsAgentConfig as m, PageFrontmatter as mn, DocsObservabilityEvent as mt, AgentFeedbackConfig as n, OpenDocsProvider as nn, DocsMcpAuthPrincipal as nt, BreadcrumbConfig as o, OpenGraphImage as on, DocsMcpConfig as ot, DocsAgentCompactConfig as p, PageAgentVerification as pn, DocsObservabilityConfig as pt, DocsCodeBlocksRunnerProvider as q, GithubConfig as qt, AlgoliaDocsSearchConfig as r, OpenDocsProviderConfig as rn, DocsMcpAuthenticate as rt, ChangelogConfig as s, OrderingItem as sn, DocsMcpCorsConfig as st, AIConfig as t, OpenDocsConfig as tn, DocsMcpAllowedOrigins as tt, CopyMarkdownConfig as u, PageAgentCommand as un, DocsMcpToolsConfig as ut, DocsAgentGoldenExpectedExample as v, ReadingTimeConfig as vn, DocsReviewCiMode as vt, DocsAgentTraceStatus as w, SidebarFolderNode as wn, DocsRobotsRule as wt, DocsAgentGoldenTaskFilters as x, SidebarComponentProps as xn, DocsReviewScoreConfig as xt, DocsAgentGoldenTask as y, ReadingTimeFormat as yn, DocsReviewConfig as yt, DocsCloudConfig as z, DocsTelemetryEvent as zt };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { c as fileExists, o as exec } from "./utils-
|
|
2
|
-
import { a as getPackagesForFramework, c as resolveDocsPackageManager, i as frameworkFromPreset, l as validateUpgradeVersion, n as PRESETS, o as presetFromFramework, r as buildDocsPackageInstallCommand, s as resolveDocsPackageFramework, t as PACKAGES_BY_FRAMEWORK } from "./package-version-
|
|
1
|
+
import { c as fileExists, o as exec } from "./utils-DBCCkkJS.mjs";
|
|
2
|
+
import { a as getPackagesForFramework, c as resolveDocsPackageManager, i as frameworkFromPreset, l as validateUpgradeVersion, n as PRESETS, o as presetFromFramework, r as buildDocsPackageInstallCommand, s as resolveDocsPackageFramework, t as PACKAGES_BY_FRAMEWORK } from "./package-version-DRIc08EU.mjs";
|
|
3
3
|
import path from "node:path";
|
|
4
4
|
import pc from "picocolors";
|
|
5
5
|
import * as p from "@clack/prompts";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@farming-labs/docs",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.55",
|
|
4
4
|
"description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"docs",
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
"build": "tsdown",
|
|
77
77
|
"dev": "tsdown --watch",
|
|
78
78
|
"typecheck": "tsc --noEmit",
|
|
79
|
-
"test": "vitest run",
|
|
79
|
+
"test": "pnpm run build && vitest run",
|
|
80
80
|
"test:watch": "vitest"
|
|
81
81
|
}
|
|
82
82
|
}
|
package/dist/agent-2t4kZLGo.mjs
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import "./reading-time-BuK2YL23.mjs";
|
|
2
|
-
import "./agent-contract-b0akaPcg.mjs";
|
|
3
|
-
import "./agent-BMxMpEa0.mjs";
|
|
4
|
-
import "./search-CJNLkdjX.mjs";
|
|
5
|
-
import "./robots-C6uQG-fS.mjs";
|
|
6
|
-
import "./sitemap-server-DnilMEiZ.mjs";
|
|
7
|
-
import "./config-DhIyFsy9.mjs";
|
|
8
|
-
import { a as readPageTokenBudget, i as printAgentCompactHelp, n as inspectAgentCompactionState, o as scanDocsPageTargets, r as parseAgentCompactArgs, t as compactAgentDocs } from "./codeblocks-DWM4IJPL.mjs";
|
|
9
|
-
|
|
10
|
-
export { compactAgentDocs, parseAgentCompactArgs, printAgentCompactHelp };
|