@farming-labs/docs 0.2.53 → 0.2.54

package/dist/{types-CdKu8KmO.d.mts → types-BVgucdVm.d.mts}

@@ -2354,11 +2354,77 @@ interface DocsAgentCompactConfig {
    */
   protectJson?: boolean;
 }
+interface DocsAgentGoldenTaskFilters {
+  /** Limit retrieval to a framework such as `nextjs`, `astro`, or `nuxt`. */
+  framework?: string;
+  /** Limit retrieval to an exact documented version. */
+  version?: string;
+  /** Limit retrieval to a locale. */
+  locale?: string;
+}
+interface DocsAgentGoldenTaskExpectation {
+  /** Canonical page or section URLs that should answer this task. */
+  relevantSources: string[];
+  /** Additional sources that may be cited without reducing precision. */
+  allowedSources?: string[];
+  /** Sources that must not be selected, for example an obsolete version. */
+  forbiddenSources?: string[];
+  /** Citations that must appear. Defaults to `relevantSources`. */
+  requiredCitations?: string[];
+  /** Minimum relevant-source recall in the top K results. Defaults to `1`. */
+  minRecallAtK?: number;
+  /** Maximum acceptable rank for the first relevant source. Defaults to `topK`. */
+  maxFirstRelevantRank?: number;
+  /** Runnable examples that must be found in retrieved context. */
+  examples?: DocsAgentGoldenExpectedExample[];
+  /** Minimum share of context bytes that must come from relevant sources. */
+  minUsefulByteRatio?: number;
+}
+interface DocsAgentGoldenExpectedExample {
+  /** Canonical page or section URL containing the example. */
+  source?: string;
+  language?: string;
+  framework?: string;
+  packageManager?: string;
+  title?: string;
+  /** Defaults to true. Set false for an intentionally non-runnable example. */
+  runnable?: boolean;
+  /** Literal fragments that must occur in the example. */
+  includes?: string[];
+}
+interface DocsAgentGoldenTask {
+  /** Stable identifier shown in doctor/review reports. */
+  id: string;
+  /** User-shaped retrieval query. */
+  query: string;
+  /** Optional retrieval scope. */
+  filters?: DocsAgentGoldenTaskFilters;
+  /** Conservative context budget. Uses the MCP context UTF-8 accounting strategy. */
+  tokenBudget?: number;
+  /** Number of ranked search results to evaluate. */
+  topK?: number;
+  /** Deterministic expectations used to score the task. */
+  expect: DocsAgentGoldenTaskExpectation;
+}
+interface DocsAgentEvaluationsConfig {
+  /** Enable deterministic golden-task evaluation. */
+  enabled?: boolean;
+  /** Default conservative context budget for tasks that omit `tokenBudget`. */
+  tokenBudget?: number;
+  /** Default retrieval depth for tasks that omit `topK`. */
+  topK?: number;
+  /** Golden tasks evaluated offline by `docs doctor` and `docs review`. */
+  tasks?: DocsAgentGoldenTask[];
+}
 interface DocsAgentConfig {
   /**
    * Defaults for `docs agent compact`.
    */
   compact?: DocsAgentCompactConfig;
+  /**
+   * Deterministic retrieval, citation, version, example, and token-budget evaluations.
+   */
+  evaluations?: boolean | DocsAgentEvaluationsConfig;
 }
 type DocsReviewSeverity = "off" | "suggestion" | "warn" | "error";
 type DocsReviewCiMode = "off" | "warn" | "block";
@@ -2379,6 +2445,16 @@ interface DocsReviewRulesConfig {
   runnableMetadata?: DocsReviewSeverity;
   /** Validate structured page agent contracts and suggest context for implementation-heavy pages. */
   agentContext?: DocsReviewSeverity;
+  /** Statically validate commands referenced by agent contracts and runnable examples. */
+  commandHealth?: DocsReviewSeverity;
+  /** Require useful related-page coverage on actionable docs pages. */
+  relatedCoverage?: DocsReviewSeverity;
+  /** Report when docs.config could not be evaluated and only partial static parsing is available. */
+  configConfidence?: DocsReviewSeverity;
+  /** Detect disagreement between discovery, resolved config, and the public config schema. */
+  agentSurfaceDrift?: DocsReviewSeverity;
+  /** Run deterministic agent golden tasks and report failed or unmeasured behavior. */
+  goldenTasks?: DocsReviewSeverity;
 }
 interface DocsReviewScoreConfig {
   /**
@@ -3078,4 +3154,4 @@ interface DocsConfig {
   og?: OGConfig;
 }
 //#endregion
-export { DocsMcpConfig as $, OpenGraphImage as $t, DocsAskAIMcpConfig as A, DocsTelemetryAgentSurface as At, DocsCodeBlocksRunnerProvider as B, GithubConfig as Bt, DocsAnalyticsSource as C, TypesenseDocsSearchConfig as Cn, DocsSearchDocument as Ct, DocsAskAIFeedbackData as D, DocsSearchResultType as Dt, DocsAskAIFeedbackConfig as E, DocsSearchResult as Et, DocsCloudPublishConfig as F, DocsTelemetryFeatures as Ft, DocsFeedbackData as G, LlmsTxtSectionConfig as Gt, DocsCodeBlocksValidationMode as H, LlmsTxtConfig as Ht, DocsCodeBlocksConfig as I, DocsTelemetryFramework as It, DocsMcpAllowedOrigins as J, OpenDocsConfig as Jt, DocsFeedbackValue as K, McpDocsSearchConfig as Kt, DocsCodeBlocksPlannerConfig as L, DocsTheme as Lt, DocsCloudConfig as M, DocsTelemetryEvent as Mt, DocsCloudFeatureConfig as N, DocsTelemetryEventInput as Nt, DocsAskAIFeedbackMessage as O, DocsSearchSourcePage as Ot, DocsCloudPreviewConfig as P, DocsTelemetryEventType as Pt, DocsMcpAuthenticateResult as Q, OpenDocsTarget as Qt, DocsCodeBlocksPlannerProvider as R, FeedbackConfig as Rt, DocsAnalyticsInput as S, ThemeToggleConfig as Sn, DocsSearchConfig as St, DocsAskAIActionType as T, UIConfig as Tn, DocsSearchQuery as Tt, DocsCodeBlocksValidationPolicy as U, LlmsTxtMaxCharsConfig as Ut, DocsCodeBlocksValidateConfig as V, LastUpdatedConfig as Vt, DocsConfig as W, LlmsTxtMaxCharsMode as Wt, DocsMcpAuthenticate as X, OpenDocsProviderConfig as Xt, DocsMcpAuthPrincipal as Y, OpenDocsProvider as Yt, DocsMcpAuthenticateContext as Z, OpenDocsProviderId as Zt, DocsAgentTraceStatus as _, SidebarFolderNode as _n, DocsRobotsRule as _t, ApiReferenceRenderer as a, PageAgentFrontmatter as an, DocsNav as at, DocsAnalyticsEventInput as b, SidebarTree as bn, DocsSearchAdapterFactory as bt, ChangelogFrontmatter as c, PageOpenGraph as cn, DocsObservabilityEventInput as ct, CopyMarkdownFormat as d, ReadingTimeConfig as dn, DocsReviewCiMode as dt, OrderingItem as en, DocsMcpCorsConfig as et, CustomDocsSearchConfig as f, ReadingTimeFormat as fn, DocsReviewConfig as ft, DocsAgentTraceEventType as g, SidebarFolderIndexBehavior as gn, DocsRobotsConfig as gt, DocsAgentTraceEventInput as h, SidebarConfig as hn, DocsReviewSeverity as ht, ApiReferenceConfig as i, PageAgentFailureMode as in, DocsMetadata as it, DocsCloudApiKeyConfig as j, DocsTelemetryConfig as jt, DocsAskAIFeedbackValue as k, DocsSitemapConfig as kt, CodeBlockCopyData as l, PageSidebarFrontmatter as ln, DocsRelatedItem as lt, DocsAgentFeedbackData as m, SidebarComponentProps as mn, DocsReviewScoreConfig as mt, AgentFeedbackConfig as n, PageAgentAppliesTo as nn, DocsMcpSecurityConfig as nt, BreadcrumbConfig as o, PageAgentVerification as on, DocsObservabilityConfig as ot, DocsAgentFeedbackContext as p, ResolvedDocsRelatedLink as pn, DocsReviewRulesConfig as pt, DocsI18nConfig as q, OGConfig as qt, AlgoliaDocsSearchConfig as r, PageAgentCommand as rn, DocsMcpToolsConfig as rt, ChangelogConfig as s, PageFrontmatter as sn, DocsObservabilityEvent as st, AIConfig as t, PageActionsConfig as tn, DocsMcpOriginContext as tt, CopyMarkdownConfig as u, PageTwitter as un, DocsReviewCiConfig as ut, DocsAnalyticsConfig as v, SidebarNode as vn, DocsSearchAdapter as vt, DocsAskAIActionData as w, TypographyConfig as wn, DocsSearchEmbeddingsConfig as wt, DocsAnalyticsEventType as x, SimpleDocsSearchConfig as xn, DocsSearchChunkingConfig as xt, DocsAnalyticsEvent as y, SidebarPageNode as yn, DocsSearchAdapterContext as yt, DocsCodeBlocksRunnerConfig as z, FontStyle as zt };
+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 };

package/dist/{upgrade-BNdBB9tQ.mjs → upgrade-CXYRNV0C.mjs}

@@ -1,5 +1,5 @@
-import { c as fileExists, o as exec } from "./utils-CMZTjRQT.mjs";
-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-DxnTZH4m.mjs";
+import { c as fileExists, o as exec } from "./utils-DBCCkkJS.mjs";
+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";
 import path from "node:path";
 import pc from "picocolors";
 import * as p from "@clack/prompts";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/docs",
-  "version": "0.2.53",
+  "version": "0.2.54",
   "description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
   "keywords": [
     "docs",

package/dist/agent-2t4kZLGo.mjs

@@ -1,10 +0,0 @@
-import "./reading-time-BuK2YL23.mjs";
-import "./agent-contract-b0akaPcg.mjs";
-import "./agent-BMxMpEa0.mjs";
-import "./search-CJNLkdjX.mjs";
-import "./robots-C6uQG-fS.mjs";
-import "./sitemap-server-DnilMEiZ.mjs";
-import "./config-DhIyFsy9.mjs";
-import { a as readPageTokenBudget, i as printAgentCompactHelp, n as inspectAgentCompactionState, o as scanDocsPageTargets, r as parseAgentCompactArgs, t as compactAgentDocs } from "./codeblocks-DWM4IJPL.mjs";
-
-export { compactAgentDocs, parseAgentCompactArgs, printAgentCompactHelp };