@farming-labs/docs 0.1.119 → 0.1.121

package/dist/server.d.mts

@@ -1,5 +1,5 @@
-import { A as DocsConfig, B as DocsObservabilityEventInput, D as DocsAskAIFeedbackMessage, E as DocsAskAIFeedbackData, G as DocsSearchAdapterContext, J as DocsSearchConfig, K as DocsSearchAdapterFactory, O as DocsAskAIFeedbackValue, Q as DocsSearchResult, R as DocsObservabilityConfig, T as DocsAskAIFeedbackConfig, W as DocsSearchAdapter, Y as DocsSearchDocument, Z as DocsSearchQuery, _ as DocsAnalyticsConfig, a as ApiReferenceRenderer, dt as McpDocsSearchConfig, et as DocsSearchSourcePage, g as DocsAgentTraceStatus, h as DocsAgentTraceEventType, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, tt as DocsSitemapConfig, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-Dts3a32G.mjs";
-import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, B as parsePromptStringArray, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, G as serializeOpenDocsProvider, H as sanitizePromptText, I as PromptProviderChoice, J as DocsAgentTraceContext, K as serializeOpenDocsProviders, L as SerializeOpenDocsProviderOptions, M as DEFAULT_OPEN_DOCS_PROVIDER_IDS, N as DEFAULT_OPEN_DOCS_TARGET, O as resolveDocsSitemapPageLastmod, P as DEFAULT_PROMPT_PROVIDER_TEMPLATES, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, U as serializeDocsIcon, V as resolvePromptProviderChoices, W as serializeDocsIconRegistry, X as ResolvedDocsObservabilityConfig, Y as ResolvedDocsAnalyticsConfig, Z as createDocsAgentTraceContext, _ as DocsSitemapFormat, a as createMcpSearchAdapter, at as createDocsCloudAnalytics, b as DocsSitemapPageInput, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAnalyticsEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_XML_ROUTE, h as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, i as createCustomSearchAdapter, it as DocsCloudAnalyticsOptions, j as DEFAULT_OPEN_DOCS_PROMPT, k as resolveDocsSitemapRequest, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_ROUTE, n as buildDocsSearchDocuments, nt as resolveDocsAnalyticsConfig, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as DOCS_AGENT_TRACE_EVENT_TYPES, r as createAlgoliaSearchAdapter, rt as resolveDocsObservabilityConfig, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsObservabilityEvent, u as performDocsSearch, v as DocsSitemapManifest, w as readDocsSitemapManifestFromContentMap, x as DocsSitemapResolvedConfig, y as DocsSitemapManifestPage, z as normalizePromptProviderName } from "./search-Dqu1Q27e.mjs";
+import { A as DocsConfig, B as DocsObservabilityEventInput, D as DocsAskAIFeedbackMessage, E as DocsAskAIFeedbackData, G as DocsReviewRulesConfig, O as DocsAskAIFeedbackValue, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, T as DocsAskAIFeedbackConfig, U as DocsReviewCiMode, W as DocsReviewConfig, X as DocsSearchAdapter, Z as DocsSearchAdapterContext, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, a as ApiReferenceRenderer, et as DocsSearchConfig, g as DocsAgentTraceStatus, h as DocsAgentTraceEventType, it as DocsSearchResult, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, ot as DocsSearchSourcePage, rt as DocsSearchQuery, st as DocsSitemapConfig, tt as DocsSearchDocument, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-CHD7M60f.mjs";
+import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, B as parsePromptStringArray, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, G as serializeOpenDocsProvider, H as sanitizePromptText, I as PromptProviderChoice, J as DocsAgentTraceContext, K as serializeOpenDocsProviders, L as SerializeOpenDocsProviderOptions, M as DEFAULT_OPEN_DOCS_PROVIDER_IDS, N as DEFAULT_OPEN_DOCS_TARGET, O as resolveDocsSitemapPageLastmod, P as DEFAULT_PROMPT_PROVIDER_TEMPLATES, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, U as serializeDocsIcon, V as resolvePromptProviderChoices, W as serializeDocsIconRegistry, X as ResolvedDocsObservabilityConfig, Y as ResolvedDocsAnalyticsConfig, Z as createDocsAgentTraceContext, _ as DocsSitemapFormat, a as createMcpSearchAdapter, at as createDocsCloudAnalytics, b as DocsSitemapPageInput, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAnalyticsEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_XML_ROUTE, h as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, i as createCustomSearchAdapter, it as DocsCloudAnalyticsOptions, j as DEFAULT_OPEN_DOCS_PROMPT, k as resolveDocsSitemapRequest, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_ROUTE, n as buildDocsSearchDocuments, nt as resolveDocsAnalyticsConfig, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as DOCS_AGENT_TRACE_EVENT_TYPES, r as createAlgoliaSearchAdapter, rt as resolveDocsObservabilityConfig, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsObservabilityEvent, u as performDocsSearch, v as DocsSitemapManifest, w as readDocsSitemapManifestFromContentMap, x as DocsSitemapResolvedConfig, y as DocsSitemapManifestPage, z as normalizePromptProviderName } from "./search-DSgDbYBT.mjs";
 import { DocsMcpCodeExample, DocsMcpConfigSchema, DocsMcpConfigSchemaOption, DocsMcpDocsList, DocsMcpDocsPageSummary, DocsMcpDocsSection, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpResolvedConfig, DocsMcpSource, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
 
 //#region src/api-reference.d.ts
@@ -52,7 +52,71 @@ declare function buildApiReferenceOpenApiDocumentAsync(config: DocsConfig, optio
 declare function buildApiReferenceHtmlDocument(config: DocsConfig, options: BuildApiReferenceHtmlOptions): string;
 declare function buildApiReferenceHtmlDocumentAsync(config: DocsConfig, options: BuildApiReferenceHtmlOptions): Promise<string>;
 //#endregion
+//#region src/review.d.ts
+declare const DEFAULT_DOCS_REVIEW_WORKFLOW_PATH = ".github/workflows/docs-review.yml";
+declare const DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD = 80;
+interface ResolvedDocsReviewConfig {
+  enabled: boolean;
+  ci: {
+    enabled: boolean;
+    name: string;
+    mode: DocsReviewCiMode;
+    annotations: boolean;
+    comment: boolean;
+  };
+  score: {
+    threshold: number;
+    weights: {
+      error: number;
+      warn: number;
+      suggestion: number;
+    };
+  };
+  rules: Required<DocsReviewRulesConfig>;
+}
+interface DocsReviewWorkflowOptions {
+  packageManager?: "npm" | "pnpm" | "yarn" | "bun";
+  ciName?: string;
+  projectDir?: string;
+  configPath?: string;
+  buildCommand?: string;
+  reviewCommand?: string;
+  pathFilters?: string[];
+}
+interface EnsureDocsReviewWorkflowOptions {
+  rootDir: string;
+  config?: DocsConfig;
+  configPath?: string;
+  configContent?: string;
+  workflowPath?: string;
+  log?: (message: string) => void;
+}
+type EnsureDocsReviewWorkflowResult = {
+  status: "created";
+  path: string;
+  relativePath: string;
+} | {
+  status: "exists";
+  path: string;
+  relativePath: string;
+} | {
+  status: "disabled";
+  path: string;
+  relativePath: string;
+};
+declare function resolveDocsReviewConfig(review?: boolean | DocsReviewConfig): ResolvedDocsReviewConfig;
+declare function buildDocsReviewWorkflow(options?: DocsReviewWorkflowOptions): string;
+declare function ensureDocsReviewWorkflow(options: EnsureDocsReviewWorkflowOptions): EnsureDocsReviewWorkflowResult;
+declare function readDocsReviewConfigFromSource(content?: string): boolean | DocsReviewConfig | undefined;
+declare function buildDocsReviewWorkflowPathFilters(options: {
+  rootDir: string;
+  repoRoot?: string;
+  config?: DocsConfig;
+  configPath?: string;
+  configContent?: string;
+}): string[];
+//#endregion
 //#region src/sitemap-server.d.ts
 declare function readDocsSitemapManifest(rootDir: string, sitemap?: boolean | DocsSitemapConfig): DocsSitemapManifest | null;
 //#endregion
-export { type ApiReferenceFramework, type ApiReferenceOpenApiDiscovery, type ApiReferenceRenderer, type ApiReferenceRoute, DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_OPEN_DOCS_PROMPT, DEFAULT_OPEN_DOCS_PROVIDER_IDS, DEFAULT_OPEN_DOCS_TARGET, DEFAULT_PROMPT_PROVIDER_TEMPLATES, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudAnalyticsOptions, type DocsMcpCodeExample, type DocsMcpConfigSchema, type DocsMcpConfigSchemaOption, type DocsMcpDocsList, type DocsMcpDocsPageSummary, type DocsMcpDocsSection, type DocsMcpHttpHandlers, type DocsMcpNavigationNode, type DocsMcpNavigationTree, type DocsMcpPage, type DocsMcpResolvedConfig, type DocsMcpSource, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchQuery, type DocsSearchResult, type DocsSearchSourcePage, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type McpDocsSearchConfig, type PromptAction, type PromptProviderChoice, type ResolvedApiReferenceConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsObservabilityConfig, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAnalytics, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };
+export { type ApiReferenceFramework, type ApiReferenceOpenApiDiscovery, type ApiReferenceRenderer, type ApiReferenceRoute, DEFAULT_API_REFERENCE_OPENAPI_ROUTE, 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_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudAnalyticsOptions, type DocsMcpCodeExample, type DocsMcpConfigSchema, type DocsMcpConfigSchemaOption, type DocsMcpDocsList, type DocsMcpDocsPageSummary, type DocsMcpDocsSection, type DocsMcpHttpHandlers, type DocsMcpNavigationNode, type DocsMcpNavigationTree, type DocsMcpPage, type DocsMcpResolvedConfig, type DocsMcpSource, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchQuery, type DocsSearchResult, type DocsSearchSourcePage, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type McpDocsSearchConfig, type PromptAction, type PromptProviderChoice, type ResolvedApiReferenceConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsObservabilityConfig, type ResolvedDocsReviewConfig, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsReviewWorkflow, buildDocsReviewWorkflowPathFilters, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAnalytics, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, ensureDocsReviewWorkflow, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsReviewConfigFromSource, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsReviewConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };

package/dist/server.mjs

@@ -1,6 +1,7 @@
 import { A as resolveDocsAnalyticsConfig, D as emitDocsAgentTraceEvent, E as createDocsAgentTraceId, M as createDocsCloudAnalytics, O as emitDocsAnalyticsEvent, T as createDocsAgentTraceContext, a as createMcpSearchAdapter, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, i as createCustomSearchAdapter, j as resolveDocsObservabilityConfig, k as emitDocsObservabilityEvent, l as inferDocsAskAIPackageHints, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch, w as DOCS_AGENT_TRACE_EVENT_TYPES } from "./search-BL7o2rXk.mjs";
 import { a as buildDocsSitemapManifest, c as renderDocsSitemapMarkdown, d as resolveDocsSitemapPageLastmod, f as resolveDocsSitemapRequest, i as DEFAULT_SITEMAP_XML_ROUTE, l as renderDocsSitemapXml, n as DEFAULT_SITEMAP_MD_ROUTE, o as createDocsSitemapResponse, p as toDocsSitemapMarkdownUrl, r as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, s as readDocsSitemapManifestFromContentMap, t as DEFAULT_SITEMAP_MANIFEST_PATH, u as resolveDocsSitemapConfig } from "./sitemap-CnqcTdQg.mjs";
 import { C as resolveApiReferenceOpenApiDiscovery, S as resolveApiReferenceConfig, _ 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-DdHzJorR.mjs";
+import { a as ensureDocsReviewWorkflow, i as buildDocsReviewWorkflowPathFilters, n as DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, o as readDocsReviewConfigFromSource, r as buildDocsReviewWorkflow, s as resolveDocsReviewConfig, t as DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD } from "./review-SngQ_dxy.mjs";
 import { createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
 
-export { DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_OPEN_DOCS_PROMPT, DEFAULT_OPEN_DOCS_PROVIDER_IDS, DEFAULT_OPEN_DOCS_TARGET, DEFAULT_PROMPT_PROVIDER_TEMPLATES, DEFAULT_SITEMAP_MANIFEST_PATH, 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, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAnalytics, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };
+export { DEFAULT_API_REFERENCE_OPENAPI_ROUTE, 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_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, createDocsCloudAnalytics, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, ensureDocsReviewWorkflow, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsReviewConfigFromSource, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsReviewConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };

package/dist/{sitemap-mqWvYODL.mjs → sitemap-CXwYOIIb.mjs}

@@ -3,8 +3,8 @@ import { a as buildDocsSitemapManifest, c as renderDocsSitemapMarkdown, l as ren
 import "./sitemap-server-DdHzJorR.mjs";
 import { createFilesystemDocsMcpSource } from "./mcp.mjs";
 import "./server.mjs";
-import { c as readNavTitle, d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, p as resolveDocsContentDir, t as extractNestedObjectLiteral, u as readStringProperty } from "./config-Cio3byUJ.mjs";
-import { t as detectFramework } from "./utils-TPe8H1P-.mjs";
+import { c as readNavTitle, d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, p as resolveDocsContentDir, t as extractNestedObjectLiteral, u as readStringProperty } from "./config-BHRL4R2v.mjs";
+import { t as detectFramework } from "./utils-x5EtYWjC.mjs";
 import { existsSync, mkdirSync, readFileSync, statSync, writeFileSync } from "node:fs";
 import path from "node:path";
 import pc from "picocolors";

package/dist/{types-Dts3a32G.d.mts → types-CHD7M60f.d.mts}

@@ -2032,6 +2032,94 @@ interface DocsAgentConfig {
    */
   compact?: DocsAgentCompactConfig;
 }
+type DocsReviewSeverity = "off" | "suggestion" | "warn" | "error";
+type DocsReviewCiMode = "off" | "warn" | "block";
+interface DocsReviewRulesConfig {
+  /** Check internal markdown/docs links. */
+  brokenLinks?: DocsReviewSeverity;
+  /** Check required page frontmatter such as title and description. */
+  frontmatter?: DocsReviewSeverity;
+  /** Check duplicate docs slugs in the resolved docs tree. */
+  duplicateSlugs?: DocsReviewSeverity;
+  /** Check whether changed markdown/MDX files can be parsed. */
+  invalidMdx?: DocsReviewSeverity;
+  /** Check docs.config examples against known config options when possible. */
+  configExamples?: DocsReviewSeverity;
+  /** Check code fences for useful metadata such as title and framework. */
+  codeFenceMetadata?: DocsReviewSeverity;
+  /** Check runnable command/code fences for package manager context. */
+  runnableMetadata?: DocsReviewSeverity;
+  /** Suggest machine-facing context for implementation-heavy pages. */
+  agentContext?: DocsReviewSeverity;
+}
+interface DocsReviewScoreConfig {
+  /**
+   * Minimum healthy score.
+   * CI reports the threshold in warn mode and blocks below it only when `ci.mode` is `"block"`.
+   *
+   * @default 80
+   */
+  threshold?: number;
+  /**
+   * Point deductions by finding severity.
+   *
+   * @default { error: 20, warn: 8, suggestion: 2 }
+   */
+  weights?: Partial<Record<"error" | "warn" | "suggestion", number>>;
+}
+interface DocsReviewCiConfig {
+  /**
+   * Enable Docs Review CI workflow generation.
+   *
+   * @default true
+   */
+  enabled?: boolean;
+  /**
+   * GitHub Actions job/check name for the generated workflow.
+   *
+   * @default "docs-review"
+   */
+  name?: string;
+  /**
+   * How CI should treat unhealthy review results.
+   *
+   * - `"off"`: do not create/report CI output
+   * - `"warn"`: report annotations but pass CI
+   * - `"block"`: fail CI when errors exist or the score is below threshold
+   *
+   * @default "warn"
+   */
+  mode?: DocsReviewCiMode;
+  /**
+   * Emit GitHub workflow command annotations in CI.
+   *
+   * @default true
+   */
+  annotations?: boolean;
+  /**
+   * Reserved for GitHub PR comments from the official action/bot.
+   *
+   * @default true
+   */
+  comment?: boolean;
+}
+interface DocsReviewConfig {
+  /**
+   * Enable Docs Review.
+   *
+   * Omitted review config is treated as enabled so docs sites get PR review CI by default.
+   * Set `review: false` to opt out.
+   *
+   * @default true
+   */
+  enabled?: boolean;
+  /** Score threshold and severity weights. */
+  score?: DocsReviewScoreConfig;
+  /** GitHub Actions behavior. */
+  ci?: boolean | DocsReviewCiConfig;
+  /** Optional rule severity overrides. */
+  rules?: DocsReviewRulesConfig;
+}
 interface DocsConfig {
   /** Entry folder for docs (e.g. "docs" → /docs) */
   entry: string;
@@ -2476,10 +2564,26 @@ interface DocsConfig {
    * Agent-oriented configuration, including defaults for `docs agent compact`.
    */
   agent?: DocsAgentConfig;
+  /**
+   * Docs Review checks changed docs files in CI/local runs and can auto-create
+   * a GitHub Actions workflow during dev/build startup.
+   *
+   * - omitted or `true` → enabled with warn-mode CI and an 80 score threshold
+   * - `false` → disable review and workflow generation
+   *
+   * @example
+   * ```ts
+   * review: {
+   *   ci: { mode: "block" },
+   *   score: { threshold: 90 },
+   * }
+   * ```
+   */
+  review?: boolean | DocsReviewConfig;
   /** SEO metadata - separate from theme */
   metadata?: DocsMetadata;
   /** Open Graph image handling */
   og?: OGConfig;
 }
 //#endregion
-export { DocsSearchResultType as $, DocsConfig as A, SidebarFolderNode as At, DocsObservabilityEventInput as B, DocsAskAIActionData as C, PageSidebarFrontmatter as Ct, DocsAskAIFeedbackMessage as D, SidebarComponentProps as Dt, DocsAskAIFeedbackData as E, ResolvedDocsRelatedLink as Et, DocsMcpToolsConfig as F, ThemeToggleConfig as Ft, DocsSearchAdapterContext as G, DocsRobotsConfig as H, DocsMetadata as I, TypesenseDocsSearchConfig as It, DocsSearchConfig as J, DocsSearchAdapterFactory as K, DocsNav as L, TypographyConfig as Lt, DocsFeedbackValue as M, SidebarPageNode as Mt, DocsI18nConfig as N, SidebarTree as Nt, DocsAskAIFeedbackValue as O, SidebarConfig as Ot, DocsMcpConfig as P, SimpleDocsSearchConfig as Pt, DocsSearchResult as Q, DocsObservabilityConfig as R, UIConfig as Rt, DocsAnalyticsSource as S, PageOpenGraph as St, DocsAskAIFeedbackConfig as T, ReadingTimeConfig as Tt, DocsRobotsRule as U, DocsRelatedItem as V, DocsSearchAdapter as W, DocsSearchEmbeddingsConfig as X, DocsSearchDocument as Y, DocsSearchQuery as Z, DocsAnalyticsConfig as _, OpenDocsTarget as _t, ApiReferenceRenderer as a, GithubConfig as at, DocsAnalyticsEventType as b, PageActionsConfig as bt, ChangelogFrontmatter as c, LlmsTxtMaxCharsConfig as ct, CustomDocsSearchConfig as d, McpDocsSearchConfig as dt, DocsSearchSourcePage as et, DocsAgentFeedbackContext as f, OGConfig as ft, DocsAgentTraceStatus as g, OpenDocsProviderId as gt, DocsAgentTraceEventType as h, OpenDocsProviderConfig as ht, ApiReferenceConfig as i, FontStyle as it, DocsFeedbackData as j, SidebarNode as jt, DocsAskAIMcpConfig as k, SidebarFolderIndexBehavior as kt, CodeBlockCopyData as l, LlmsTxtMaxCharsMode as lt, DocsAgentTraceEventInput as m, OpenDocsProvider as mt, AgentFeedbackConfig as n, DocsTheme as nt, BreadcrumbConfig as o, LastUpdatedConfig as ot, DocsAgentFeedbackData as p, OpenDocsConfig as pt, DocsSearchChunkingConfig as q, AlgoliaDocsSearchConfig as r, FeedbackConfig as rt, ChangelogConfig as s, LlmsTxtConfig as st, AIConfig as t, DocsSitemapConfig as tt, CopyMarkdownConfig as u, LlmsTxtSectionConfig as ut, DocsAnalyticsEvent as v, OpenGraphImage as vt, DocsAskAIActionType as w, PageTwitter as wt, DocsAnalyticsInput as x, PageFrontmatter as xt, DocsAnalyticsEventInput as y, OrderingItem as yt, DocsObservabilityEvent as z };
+export { DocsSearchChunkingConfig as $, DocsConfig as A, PageTwitter as At, DocsObservabilityEventInput as B, SimpleDocsSearchConfig as Bt, DocsAskAIActionData as C, OpenDocsTarget as Ct, DocsAskAIFeedbackMessage as D, PageFrontmatter as Dt, DocsAskAIFeedbackData as E, PageActionsConfig as Et, DocsMcpToolsConfig as F, SidebarFolderIndexBehavior as Ft, DocsReviewRulesConfig as G, DocsReviewCiConfig as H, TypesenseDocsSearchConfig as Ht, DocsMetadata as I, SidebarFolderNode as It, DocsRobotsConfig as J, DocsReviewScoreConfig as K, DocsNav as L, SidebarNode as Lt, DocsFeedbackValue as M, ResolvedDocsRelatedLink as Mt, DocsI18nConfig as N, SidebarComponentProps as Nt, DocsAskAIFeedbackValue as O, PageOpenGraph as Ot, DocsMcpConfig as P, SidebarConfig as Pt, DocsSearchAdapterFactory as Q, DocsObservabilityConfig as R, SidebarPageNode as Rt, DocsAnalyticsSource as S, OpenDocsProviderId as St, DocsAskAIFeedbackConfig as T, OrderingItem as Tt, DocsReviewCiMode as U, TypographyConfig as Ut, DocsRelatedItem as V, ThemeToggleConfig as Vt, DocsReviewConfig as W, UIConfig as Wt, DocsSearchAdapter as X, DocsRobotsRule as Y, DocsSearchAdapterContext as Z, DocsAnalyticsConfig as _, McpDocsSearchConfig as _t, ApiReferenceRenderer as a, DocsSearchResultType as at, DocsAnalyticsEventType as b, OpenDocsProvider as bt, ChangelogFrontmatter as c, DocsTheme as ct, CustomDocsSearchConfig as d, GithubConfig as dt, DocsSearchConfig as et, DocsAgentFeedbackContext as f, LastUpdatedConfig as ft, DocsAgentTraceStatus as g, LlmsTxtSectionConfig as gt, DocsAgentTraceEventType as h, LlmsTxtMaxCharsMode as ht, ApiReferenceConfig as i, DocsSearchResult as it, DocsFeedbackData as j, ReadingTimeConfig as jt, DocsAskAIMcpConfig as k, PageSidebarFrontmatter as kt, CodeBlockCopyData as l, FeedbackConfig as lt, DocsAgentTraceEventInput as m, LlmsTxtMaxCharsConfig as mt, AgentFeedbackConfig as n, DocsSearchEmbeddingsConfig as nt, BreadcrumbConfig as o, DocsSearchSourcePage as ot, DocsAgentFeedbackData as p, LlmsTxtConfig as pt, DocsReviewSeverity as q, AlgoliaDocsSearchConfig as r, DocsSearchQuery as rt, ChangelogConfig as s, DocsSitemapConfig as st, AIConfig as t, DocsSearchDocument as tt, CopyMarkdownConfig as u, FontStyle as ut, DocsAnalyticsEvent as v, OGConfig as vt, DocsAskAIActionType as w, OpenGraphImage as wt, DocsAnalyticsInput as x, OpenDocsProviderConfig as xt, DocsAnalyticsEventInput as y, OpenDocsConfig as yt, DocsObservabilityEvent as z, SidebarTree as zt };

package/dist/{upgrade-B1EMfRQJ.mjs → upgrade-DrOWQIKI.mjs}

@@ -1,5 +1,5 @@
-import { c as fileExists, o as exec } from "./utils-TPe8H1P-.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-DQgrHnSb.mjs";
+import { c as fileExists, o as exec } from "./utils-x5EtYWjC.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-L4GZowaF.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.1.119",
+  "version": "0.1.121",
   "description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
   "keywords": [
     "docs",