@farming-labs/docs 0.1.120 → 0.1.122

package/dist/cli/index.mjs

@@ -122,7 +122,7 @@ async function main() {
 		}
 		await runDoctor(doctorOptions);
 	} else if (parsedCommand.command === "review") {
-		const { parseReviewArgs, printReviewHelp, runReview } = await import("../review-BHFhvl2F.mjs");
+		const { parseReviewArgs, printReviewHelp, runReview } = await import("../review-DEG_UnxV.mjs");
 		const reviewOptions = parseReviewArgs(args.slice(1));
 		if (reviewOptions.help) {
 			printReviewHelp();

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { $ as DocsSearchChunkingConfig, A as DocsConfig, At as PageTwitter, B as DocsObservabilityEventInput, Bt as SimpleDocsSearchConfig, C as DocsAskAIActionData, Ct as OpenDocsTarget, D as DocsAskAIFeedbackMessage, Dt as PageFrontmatter, E as DocsAskAIFeedbackData, Et as PageActionsConfig, F as DocsMcpToolsConfig, Ft as SidebarFolderIndexBehavior, G as DocsReviewRulesConfig, H as DocsReviewCiConfig, Ht as TypesenseDocsSearchConfig, I as DocsMetadata, It as SidebarFolderNode, J as DocsRobotsConfig, K as DocsReviewScoreConfig, L as DocsNav, Lt as SidebarNode, M as DocsFeedbackValue, Mt as ResolvedDocsRelatedLink, N as DocsI18nConfig, Nt as SidebarComponentProps, O as DocsAskAIFeedbackValue, Ot as PageOpenGraph, P as DocsMcpConfig, Pt as SidebarConfig, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, Rt as SidebarPageNode, S as DocsAnalyticsSource, St as OpenDocsProviderId, T as DocsAskAIFeedbackConfig, Tt as OrderingItem, U as DocsReviewCiMode, Ut as TypographyConfig, V as DocsRelatedItem, Vt as ThemeToggleConfig, W as DocsReviewConfig, Wt as UIConfig, X as DocsSearchAdapter, Y as DocsRobotsRule, Z as DocsSearchAdapterContext, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, a as ApiReferenceRenderer, at as DocsSearchResultType, b as DocsAnalyticsEventType, bt as OpenDocsProvider, c as ChangelogFrontmatter, ct as DocsTheme, d as CustomDocsSearchConfig, dt as GithubConfig, et as DocsSearchConfig, f as DocsAgentFeedbackContext, ft as LastUpdatedConfig, g as DocsAgentTraceStatus, gt as LlmsTxtSectionConfig, h as DocsAgentTraceEventType, ht as LlmsTxtMaxCharsMode, i as ApiReferenceConfig, it as DocsSearchResult, j as DocsFeedbackData, jt as ReadingTimeConfig, k as DocsAskAIMcpConfig, kt as PageSidebarFrontmatter, l as CodeBlockCopyData, lt as FeedbackConfig, m as DocsAgentTraceEventInput, mt as LlmsTxtMaxCharsConfig, n as AgentFeedbackConfig, nt as DocsSearchEmbeddingsConfig, o as BreadcrumbConfig, ot as DocsSearchSourcePage, p as DocsAgentFeedbackData, pt as LlmsTxtConfig, q as DocsReviewSeverity, r as AlgoliaDocsSearchConfig, rt as DocsSearchQuery, s as ChangelogConfig, st as DocsSitemapConfig, t as AIConfig, tt as DocsSearchDocument, u as CopyMarkdownConfig, ut as FontStyle, v as DocsAnalyticsEvent, vt as OGConfig, w as DocsAskAIActionType, wt as OpenGraphImage, x as DocsAnalyticsInput, xt as OpenDocsProviderConfig, y as DocsAnalyticsEventInput, yt as OpenDocsConfig, z as DocsObservabilityEvent, zt as SidebarTree } from "./types-DtBNjsk2.mjs";
-import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, I as PromptProviderChoice, J as DocsAgentTraceContext, L as SerializeOpenDocsProviderOptions, O as resolveDocsSitemapPageLastmod, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, 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, 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 } from "./search-Dd0kOr6B.mjs";
+import { $ as DocsSearchChunkingConfig, A as DocsConfig, At as PageTwitter, B as DocsObservabilityEventInput, Bt as SimpleDocsSearchConfig, C as DocsAskAIActionData, Ct as OpenDocsTarget, D as DocsAskAIFeedbackMessage, Dt as PageFrontmatter, E as DocsAskAIFeedbackData, Et as PageActionsConfig, F as DocsMcpToolsConfig, Ft as SidebarFolderIndexBehavior, G as DocsReviewRulesConfig, H as DocsReviewCiConfig, Ht as TypesenseDocsSearchConfig, I as DocsMetadata, It as SidebarFolderNode, J as DocsRobotsConfig, K as DocsReviewScoreConfig, L as DocsNav, Lt as SidebarNode, M as DocsFeedbackValue, Mt as ResolvedDocsRelatedLink, N as DocsI18nConfig, Nt as SidebarComponentProps, O as DocsAskAIFeedbackValue, Ot as PageOpenGraph, P as DocsMcpConfig, Pt as SidebarConfig, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, Rt as SidebarPageNode, S as DocsAnalyticsSource, St as OpenDocsProviderId, T as DocsAskAIFeedbackConfig, Tt as OrderingItem, U as DocsReviewCiMode, Ut as TypographyConfig, V as DocsRelatedItem, Vt as ThemeToggleConfig, W as DocsReviewConfig, Wt as UIConfig, X as DocsSearchAdapter, Y as DocsRobotsRule, Z as DocsSearchAdapterContext, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, a as ApiReferenceRenderer, at as DocsSearchResultType, b as DocsAnalyticsEventType, bt as OpenDocsProvider, c as ChangelogFrontmatter, ct as DocsTheme, d as CustomDocsSearchConfig, dt as GithubConfig, et as DocsSearchConfig, f as DocsAgentFeedbackContext, ft as LastUpdatedConfig, g as DocsAgentTraceStatus, gt as LlmsTxtSectionConfig, h as DocsAgentTraceEventType, ht as LlmsTxtMaxCharsMode, i as ApiReferenceConfig, it as DocsSearchResult, j as DocsFeedbackData, jt as ReadingTimeConfig, k as DocsAskAIMcpConfig, kt as PageSidebarFrontmatter, l as CodeBlockCopyData, lt as FeedbackConfig, m as DocsAgentTraceEventInput, mt as LlmsTxtMaxCharsConfig, n as AgentFeedbackConfig, nt as DocsSearchEmbeddingsConfig, o as BreadcrumbConfig, ot as DocsSearchSourcePage, p as DocsAgentFeedbackData, pt as LlmsTxtConfig, q as DocsReviewSeverity, r as AlgoliaDocsSearchConfig, rt as DocsSearchQuery, s as ChangelogConfig, st as DocsSitemapConfig, t as AIConfig, tt as DocsSearchDocument, u as CopyMarkdownConfig, ut as FontStyle, v as DocsAnalyticsEvent, vt as OGConfig, w as DocsAskAIActionType, wt as OpenGraphImage, x as DocsAnalyticsInput, xt as OpenDocsProviderConfig, y as DocsAnalyticsEventInput, yt as OpenDocsConfig, z as DocsObservabilityEvent, zt as SidebarTree } from "./types-CHD7M60f.mjs";
+import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, I as PromptProviderChoice, J as DocsAgentTraceContext, L as SerializeOpenDocsProviderOptions, O as resolveDocsSitemapPageLastmod, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, 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, 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 } from "./search-DSgDbYBT.mjs";
 import { DocsMcpPage, DocsMcpResolvedConfig } from "./mcp.mjs";
 
 //#region src/define-docs.d.ts

package/dist/mcp.d.mts

@@ -1,4 +1,4 @@
-import { P as DocsMcpConfig, R as DocsObservabilityConfig, Tt as OrderingItem, _ as DocsAnalyticsConfig, et as DocsSearchConfig, ot as DocsSearchSourcePage } from "./types-DtBNjsk2.mjs";
+import { P as DocsMcpConfig, R as DocsObservabilityConfig, Tt as OrderingItem, _ as DocsAnalyticsConfig, et as DocsSearchConfig, ot as DocsSearchSourcePage } from "./types-CHD7M60f.mjs";
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 
 //#region src/mcp.d.ts

package/dist/{review-_5fnI667.mjs → review-B7goPYUb.mjs}

@@ -3,7 +3,12 @@ import { dirname, isAbsolute, join, relative } from "node:path";
 
 //#region src/review.ts
 const DEFAULT_DOCS_REVIEW_WORKFLOW_PATH = ".github/workflows/docs-review.yml";
+const DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW_PATH = ".github/workflows/docs-review-reusable.yml";
+const DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW = "farming-labs/docs/.github/workflows/docs-review-reusable.yml@main";
+const LOCAL_DOCS_REVIEW_REUSABLE_WORKFLOW = "./.github/workflows/docs-review-reusable.yml";
+const DEFAULT_DOCS_REVIEW_PNPM_VERSION = "10";
 const DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD = 80;
+const DEFAULT_DOCS_REVIEW_CI_NAME = "docs-review";
 const DEFAULT_REVIEW_RULES = {
 	brokenLinks: "error",
 	frontmatter: "error",
@@ -41,6 +46,7 @@ function resolveDocsReviewConfig(review) {
 		enabled: false,
 		ci: {
 			enabled: false,
+			name: DEFAULT_DOCS_REVIEW_CI_NAME,
 			mode: "off",
 			annotations: false,
 			comment: false
@@ -62,6 +68,7 @@ function resolveDocsReviewConfig(review) {
 		enabled,
 		ci: {
 			enabled: ciEnabled,
+			name: normalizeCiName(ciObject.name),
 			mode: ciEnabled ? mode : "off",
 			annotations: ciObject.annotations !== false,
 			comment: ciObject.comment !== false
@@ -82,13 +89,20 @@ function resolveDocsReviewConfig(review) {
 }
 function buildDocsReviewWorkflow(options = {}) {
 	const packageManager = options.packageManager ?? "npm";
+	const ciName = normalizeCiName(options.ciName);
 	const projectDir = normalizeProjectDir(options.projectDir);
-	const configArg = options.configPath ? ` --config ${shellQuote(options.configPath)}` : "";
-	const reviewCommand = `${options.reviewCommand ?? reviewCommandForPackageManager(packageManager)} review --ci${configArg}`;
+	const configPath = options.configPath ?? "docs.config.ts";
+	const reusableWorkflow = options.reusableWorkflow ?? DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW;
 	const filters = normalizePathFilters(options.pathFilters);
-	const installSteps = buildInstallSteps(packageManager);
-	const buildStep = options.buildCommand ? `\n      - name: Build docs CLI\n        run: ${options.buildCommand}\n` : "";
-	const workingDirectoryLine = projectDir === "." ? "" : `\n        working-directory: ${projectDir}`;
+	const workflowInputs = [
+		["check-name", ciName],
+		["config", configPath],
+		["working-directory", projectDir],
+		["package-manager", packageManager],
+		options.pnpmVersion ? ["pnpm-version", options.pnpmVersion] : void 0,
+		options.buildCommand ? ["build-command", options.buildCommand] : void 0,
+		options.reviewCommand ? ["review-command", options.reviewCommand] : void 0
+	].filter((input) => Boolean(input)).map(([key, value]) => `      ${key}: ${JSON.stringify(value)}`).join("\n");
 	return `# Generated by @farming-labs/docs. You can edit this file.
 name: Docs Review
 
@@ -104,17 +118,14 @@ permissions:
 
 jobs:
   docs-review:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-${installSteps}
-${buildStep}
-
-      - name: Review docs
-        run: ${reviewCommand}${workingDirectoryLine}
+    name: ${JSON.stringify(ciName)}
+    uses: ${reusableWorkflow}
+    with:
+${workflowInputs}
+    permissions:
+      contents: read
+      checks: write
+      pull-requests: write
 `;
 }
 function ensureDocsReviewWorkflow(options) {
@@ -140,6 +151,9 @@ function ensureDocsReviewWorkflow(options) {
 	const packageManager = detectPackageManager(repoRoot);
 	const workflow = buildDocsReviewWorkflow({
 		packageManager,
+		ciName: review.ci.name,
+		reusableWorkflow: hasLocalDocsWorkspacePackage(repoRoot) ? LOCAL_DOCS_REVIEW_REUSABLE_WORKFLOW : DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW,
+		pnpmVersion: detectPnpmVersionFallback(repoRoot, packageManager),
 		projectDir,
 		configPath,
 		buildCommand: detectLocalDocsCliBuildCommand(repoRoot, packageManager),
@@ -203,7 +217,8 @@ function buildDocsReviewWorkflowPathFilters(options) {
 		prefixPath(projectPrefix, "content/docs/**"),
 		prefixPath(projectPrefix, "src/content/docs/**"),
 		prefixPath(projectPrefix, "src/lib/docs.config.*"),
-		DEFAULT_DOCS_REVIEW_WORKFLOW_PATH
+		DEFAULT_DOCS_REVIEW_WORKFLOW_PATH,
+		DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW_PATH
 	];
 	return Array.from(new Set(candidates.filter((candidate) => Boolean(candidate))));
 }
@@ -214,6 +229,9 @@ function normalizeRules(rules) {
 function normalizeWeight(value, fallback) {
 	return typeof value === "number" && Number.isFinite(value) && value >= 0 ? value : fallback;
 }
+function normalizeCiName(value) {
+	return value?.trim() || DEFAULT_DOCS_REVIEW_CI_NAME;
+}
 function clampScoreThreshold(value) {
 	if (typeof value !== "number" || !Number.isFinite(value)) return DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD;
 	return Math.min(100, Math.max(0, Math.round(value)));
@@ -225,6 +243,7 @@ function readReviewCiObject(source, cursor) {
 	const mode = readTopLevelString(block, "mode");
 	return {
 		enabled: readTopLevelBoolean(block, "enabled"),
+		name: readTopLevelString(block, "name"),
 		mode: mode && REVIEW_CI_MODES.has(mode) ? mode : void 0,
 		annotations: readTopLevelBoolean(block, "annotations"),
 		comment: readTopLevelBoolean(block, "comment")
@@ -260,6 +279,13 @@ function detectLocalDocsCliBuildCommand(repoRoot, packageManager) {
 	if (packageManager === "bun") return "bun run --filter @farming-labs/docs build";
 	return "npm run build --workspace=@farming-labs/docs";
 }
+function detectPnpmVersionFallback(repoRoot, packageManager) {
+	if (packageManager !== "pnpm") return void 0;
+	try {
+		if (JSON.parse(readFileSync(join(repoRoot, "package.json"), "utf-8")).packageManager?.startsWith("pnpm@")) return void 0;
+	} catch {}
+	return DEFAULT_DOCS_REVIEW_PNPM_VERSION;
+}
 function detectLocalDocsCliReviewCommand(repoRoot, rootDir) {
 	if (!hasLocalDocsWorkspacePackage(repoRoot)) return void 0;
 	return `node ${shellQuote(toPosixPath(relative(rootDir, join(repoRoot, "packages", "docs", "dist", "cli", "index.mjs"))) || "./packages/docs/dist/cli/index.mjs")}`;
@@ -274,44 +300,6 @@ function hasLocalDocsWorkspacePackage(repoRoot) {
 		return false;
 	}
 }
-function buildInstallSteps(packageManager) {
-	if (packageManager === "pnpm") return `      - uses: pnpm/action-setup@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: pnpm
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile`;
-	if (packageManager === "yarn") return `      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: yarn
-
-      - name: Enable Corepack
-        run: corepack enable
-
-      - name: Install dependencies
-        run: yarn install --immutable || yarn install --frozen-lockfile`;
-	if (packageManager === "bun") return `      - uses: oven-sh/setup-bun@v2
-
-      - name: Install dependencies
-        run: bun install --frozen-lockfile`;
-	return `      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci`;
-}
-function reviewCommandForPackageManager(packageManager) {
-	if (packageManager === "pnpm") return "pnpm exec docs";
-	if (packageManager === "yarn") return "yarn exec docs";
-	if (packageManager === "bun") return "bunx docs";
-	return "npx --no-install docs";
-}
 function shellQuote(value) {
 	if (/^[A-Za-z0-9_./:-]+$/.test(value)) return value;
 	return `'${value.replaceAll("'", "'\\''")}'`;

package/dist/{review-BHFhvl2F.mjs → review-DEG_UnxV.mjs}

@@ -1,4 +1,4 @@
-import { a as ensureDocsReviewWorkflow, o as readDocsReviewConfigFromSource, s as resolveDocsReviewConfig } from "./review-_5fnI667.mjs";
+import { a as ensureDocsReviewWorkflow, o as readDocsReviewConfigFromSource, s as resolveDocsReviewConfig } from "./review-B7goPYUb.mjs";
 import { d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, p as resolveDocsContentDir } from "./config-BHRL4R2v.mjs";
 import matter from "gray-matter";
 import { existsSync, lstatSync, readFileSync, readdirSync } from "node:fs";

package/dist/{search-Dd0kOr6B.d.mts → search-DSgDbYBT.d.mts}

@@ -1,4 +1,4 @@
-import { $ as DocsSearchChunkingConfig, B as DocsObservabilityEventInput, Ct as OpenDocsTarget, Ht as TypesenseDocsSearchConfig, Mt as ResolvedDocsRelatedLink, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, X as DocsSearchAdapter, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, bt as OpenDocsProvider, d as CustomDocsSearchConfig, et as DocsSearchConfig, it as DocsSearchResult, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, ot as DocsSearchSourcePage, r as AlgoliaDocsSearchConfig, st as DocsSitemapConfig, tt as DocsSearchDocument, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-DtBNjsk2.mjs";
+import { $ as DocsSearchChunkingConfig, B as DocsObservabilityEventInput, Ct as OpenDocsTarget, Ht as TypesenseDocsSearchConfig, Mt as ResolvedDocsRelatedLink, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, X as DocsSearchAdapter, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, bt as OpenDocsProvider, d as CustomDocsSearchConfig, et as DocsSearchConfig, it as DocsSearchResult, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, ot as DocsSearchSourcePage, r as AlgoliaDocsSearchConfig, st as DocsSitemapConfig, tt as DocsSearchDocument, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-CHD7M60f.mjs";
 
 //#region src/cloud-analytics.d.ts
 interface DocsCloudAnalyticsOptions {

package/dist/server.d.mts

@@ -1,5 +1,5 @@
-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-DtBNjsk2.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-Dd0kOr6B.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
@@ -59,6 +59,7 @@ interface ResolvedDocsReviewConfig {
   enabled: boolean;
   ci: {
     enabled: boolean;
+    name: string;
     mode: DocsReviewCiMode;
     annotations: boolean;
     comment: boolean;
@@ -75,6 +76,9 @@ interface ResolvedDocsReviewConfig {
 }
 interface DocsReviewWorkflowOptions {
   packageManager?: "npm" | "pnpm" | "yarn" | "bun";
+  ciName?: string;
+  reusableWorkflow?: string;
+  pnpmVersion?: string;
   projectDir?: string;
   configPath?: string;
   buildCommand?: string;

package/dist/server.mjs

@@ -1,7 +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-_5fnI667.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-B7goPYUb.mjs";
 import { createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
 
 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/{types-DtBNjsk2.d.mts → types-CHD7M60f.d.mts}

@@ -2074,6 +2074,12 @@ interface DocsReviewCiConfig {
    * @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.
    *

package/package.json

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