@open-agent-toolkit/cli 0.3.31 → 0.3.33

package/dist/commands/docs/index-generate/index.d.ts

@@ -4,7 +4,7 @@ import { Command } from 'commander';
 export declare const GENERATED_INDEX_WARNING = "<!-- AUTOGENERATED by `oat docs generate-index`. Do not hand-edit; run `oat docs generate-index` to regenerate. -->";
 interface IndexGenerateFileDependencies {
     generateIndex: (docsDir: string, options: import('./generator.js').GenerateIndexOptions) => Promise<import('./generator.js').IndexEntry[]>;
-    renderIndex: (entries: import('./generator.js').IndexEntry[]) => string;
+    renderIndex: (entries: import('./generator.js').IndexEntry[], options?: import('./generator.js').RenderIndexOptions) => string;
     writeFile: (path: string, content: string, encoding: BufferEncoding) => Promise<void>;
     readOatConfig: (repoRoot: string) => Promise<OatConfig>;
     writeOatConfig: (repoRoot: string, config: OatConfig) => Promise<void>;

package/dist/commands/docs/index-generate/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/commands/docs/index-generate/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,aAAa,EACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,KAAK,SAAS,EAGf,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAE,OAAO,EAAU,MAAM,WAAW,CAAC;AAI5C,eAAO,MAAM,uBAAuB,wHACmF,CAAC;AA2BxH,UAAU,6BAA6B;IACrC,aAAa,EAAE,CACb,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,aAAa,EAAE,oBAAoB,KAChD,OAAO,CAAC,OAAO,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC;IACjD,WAAW,EAAE,CAAC,OAAO,EAAE,OAAO,aAAa,EAAE,UAAU,EAAE,KAAK,MAAM,CAAC;IACrE,SAAS,EAAE,CACT,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,cAAc,KACrB,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACxD,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,eAAe,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAClD,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9C,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC5D,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CAC7D;AAED,UAAU,yBAAyB;IACjC,mBAAmB,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,cAAc,CAAC;IAChE,QAAQ,EAAE,6BAA6B,CAAC;CACzC;AAmrBD,wBAAgB,8BAA8B,CAC5C,SAAS,GAAE,OAAO,CAAC,yBAAyB,CAAM,GACjD,OAAO,CAgCT"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/commands/docs/index-generate/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,aAAa,EACnB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,KAAK,SAAS,EAGf,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAE,OAAO,EAAU,MAAM,WAAW,CAAC;AAI5C,eAAO,MAAM,uBAAuB,wHACmF,CAAC;AA2BxH,UAAU,6BAA6B;IACrC,aAAa,EAAE,CACb,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,aAAa,EAAE,oBAAoB,KAChD,OAAO,CAAC,OAAO,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC;IACjD,WAAW,EAAE,CACX,OAAO,EAAE,OAAO,aAAa,EAAE,UAAU,EAAE,EAC3C,OAAO,CAAC,EAAE,OAAO,aAAa,EAAE,kBAAkB,KAC/C,MAAM,CAAC;IACZ,SAAS,EAAE,CACT,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,cAAc,KACrB,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACxD,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,eAAe,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAClD,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9C,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC5D,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CAC7D;AAED,UAAU,yBAAyB;IACjC,mBAAmB,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,cAAc,CAAC;IAChE,QAAQ,EAAE,6BAA6B,CAAC;CACzC;AAgsBD,wBAAgB,8BAA8B,CAC5C,SAAS,GAAE,OAAO,CAAC,yBAAyB,CAAM,GACjD,OAAO,CAgCT"}

package/dist/commands/docs/index-generate/index.js

@@ -430,19 +430,31 @@ async function runIndexGenerate(context, options, deps) {
     const entries = await deps.generateIndex(docsDir, {
         excludes: resolved.excludes,
     });
-    const content = buildGeneratedIndexOutput(deps.renderIndex(entries), resolved.config.documentation?.tooling);
+    // Links are written relative to the manifest file, which always sits outside
+    // the docs directory it indexes. When this run records the manifest in
+    // `documentation.index`, links resolve from that recorded (real) location.
+    // Otherwise only the output's directory is canonicalized: a symlinked
+    // directory alias cannot skew the prefix, and a file symlink is read from its
+    // own location.
+    const indexPath = isFumadocsManifestTransition(resolved, canonical)
+        ? buildDocumentationIndexValue(resolved, canonical)
+        : null;
+    const outputDir = indexPath !== null
+        ? dirname(canonical.outputPath)
+        : ((await canonicalizeOrNull(dirname(outputPath), deps, {
+            kind: 'output',
+        })) ?? dirname(outputPath));
+    const linkBase = normalizeToPosixPath(relative(outputDir, canonical.docsDir));
+    const content = buildGeneratedIndexOutput(deps.renderIndex(entries, { linkBase }), resolved.config.documentation?.tooling);
     await deps.writeFile(outputPath, content, 'utf8');
-    if (isFumadocsManifestTransition(resolved, canonical)) {
-        const indexPath = buildDocumentationIndexValue(resolved, canonical);
-        if (indexPath !== null && config.documentation?.index !== indexPath) {
-            await deps.writeOatConfig(repoRoot, {
-                ...config,
-                documentation: {
-                    ...config.documentation,
-                    index: indexPath,
-                },
-            });
-        }
+    if (indexPath !== null && config.documentation?.index !== indexPath) {
+        await deps.writeOatConfig(repoRoot, {
+            ...config,
+            documentation: {
+                ...config.documentation,
+                index: indexPath,
+            },
+        });
     }
     if (context.json) {
         context.logger.json({

package/dist/commands/docs/init/content.d.ts

@@ -1,7 +1,6 @@
-export declare const IA_PRESETS: readonly ['product-engineering-qa', 'consumer-maintainer', 'domain-engineering', 'task-type', 'toolkit-cli', 'flat-small'];
-export type IaPreset = (typeof IA_PRESETS)[number];
+import { type IaPresetId } from '../../../config/documentation-ia.js';
 export interface PresetSelection {
-    iaPreset?: IaPreset;
+    iaPreset?: IaPresetId;
     plannedPages?: number;
 }
 /** Validate the opt-in pair before planning or writing any scaffold files. */

package/dist/commands/docs/init/content.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../../../src/commands/docs/init/content.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,UAAU,YACrB,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,WAAW,EACX,aAAa,EACb,YAAY,CACJ,CAAC;AACX,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AACnD,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,8EAA8E;AAC9E,wBAAgB,sBAAsB,CACpC,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GACtB,eAAe,CAiBjB;AAmSD,wBAAgB,sBAAsB,CAAC,KAAK,GAAE,MAAM,EAAO,GAAG,MAAM,EAAE,CAErE;AAQD,sFAAsF;AACtF,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,eAAe,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,OAAO,CAAC;CACnB,GACA,OAAO,CAAC;IACT,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC3C,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,IAAI,CAAC,CAwFR"}
+{"version":3,"file":"content.d.ts","sourceRoot":"","sources":["../../../../src/commands/docs/init/content.ts"],"names":[],"mappings":"AAGA,OAAO,EAAiB,KAAK,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC1E,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,UAAU,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,8EAA8E;AAC9E,wBAAgB,sBAAsB,CACpC,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GACtB,eAAe,CAiBjB;AAmSD,wBAAgB,sBAAsB,CAAC,KAAK,GAAE,MAAM,EAAO,GAAG,MAAM,EAAE,CAErE;AAQD,sFAAsF;AACtF,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,eAAe,GAAG;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,OAAO,CAAC;CACnB,GACA,OAAO,CAAC;IACT,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC3C,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,IAAI,CAAC,CAwFR"}

package/dist/commands/docs/init/content.js

@@ -1,21 +1,14 @@
 import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
-export const IA_PRESETS = [
-    'product-engineering-qa',
-    'consumer-maintainer',
-    'domain-engineering',
-    'task-type',
-    'toolkit-cli',
-    'flat-small',
-];
+import { IA_PRESET_IDS } from '../../../config/documentation-ia.js';
 /** Validate the opt-in pair before planning or writing any scaffold files. */
 export function resolvePresetSelection(preset, count) {
     if (preset === undefined && count === undefined)
         return {};
     if (preset === undefined || count === undefined)
         throw new Error('--ia-preset and --planned-pages are required together.');
-    if (!IA_PRESETS.includes(preset))
-        throw new Error(`Unknown IA preset "${preset}". Choose: ${IA_PRESETS.join(', ')}.`);
+    if (!IA_PRESET_IDS.includes(preset))
+        throw new Error(`Unknown IA preset "${preset}". Choose: ${IA_PRESET_IDS.join(', ')}.`);
     if (!/^\d+$/.test(String(count)) ||
         !Number.isSafeInteger(Number(count)) ||
         Number(count) < 1)

package/dist/commands/docs/nav/fumadocs.d.ts

@@ -27,6 +27,9 @@ export interface SyncFumadocsNavigationResult {
      */
     unlisted: string[];
 }
+export declare const FUMADOCS_REST_ITEMS: ReadonlySet<string>;
+export declare const FUMADOCS_SEPARATOR: RegExp;
+export declare const FUMADOCS_LINK: RegExp;
 /**
  * Reduce a Markdown heading to the plain text a sidebar shows: images and
  * links keep their text, code spans keep their content, and emphasis and
@@ -35,6 +38,12 @@ export interface SyncFumadocsNavigationResult {
 export declare function stripInlineMarkdown(text: string): string;
 /** Folder title: frontmatter `title`, else the first H1 outside code fences. */
 export declare function resolveFolderTitle(markdown: string): string | undefined;
+/**
+ * The URL Fumadocs assigns a page, following `getSlugs` in fumadocs-core's
+ * slugs plugin with the scaffolded `baseUrl: '/'`: group folders are dropped,
+ * segments are URI-encoded, and an `index` file maps to its folder.
+ */
+export declare function pageUrl(pagePath: string, nonIndexUrls?: ReadonlySet<string>): string;
 /**
  * The `pages` item for a page or folder in the same directory. A name the
  * builder would read as a directive (`!hidden`, `z...a`, `---`, ...) is
@@ -42,6 +51,26 @@ export declare function resolveFolderTitle(markdown: string): string | undefined
  * the same file; every other name is written as is.
  */
 export declare function toFumadocsPageItem(name: string): string;
+/**
+ * Build one folder's `pages` from its index.md Contents map.
+ *
+ * A page in this folder or an immediate subfolder is referenced by name.
+ * Local same-name page/folder collisions use a precise source-file item, as
+ * does `../contributing.md` from its own contributing/ map: pinned core16.10.2
+ * selects the folder first for an extensionless reference. Other non-local
+ * targets become link entries. There is never a `"..."` rest entry: pages the Contents map does
+ * not list stay out of the tree and are reported instead.
+ */
+/**
+ * Whether the fumadocs-core 16.10.2 page-tree builder supplies this folder's
+ * `index` page on its own, given the folder's effective metadata.
+ *
+ * `buildFolder` attaches `<folder>/index` as the folder index only when the
+ * folder is not a root folder (the docs root, or a preserved `root: true`)
+ * and no `pagesIndex` names a different page. Otherwise the page is shown
+ * only if `pages` lists it.
+ */
+export declare function hasImplicitIndex(relativeDir: string, existing: Record<string, unknown> | null): boolean;
 /**
  * Write one strict `meta.json` per docs directory that has an index.md,
  * derived from that index's Contents map, and report every page the

package/dist/commands/docs/nav/fumadocs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fumadocs.d.ts","sourceRoot":"","sources":["../../../../src/commands/docs/nav/fumadocs.ts"],"names":[],"mappings":"AAoBA;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,mEAAmE;IACnE,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;;OAGG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;;OAGG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AA6DD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQxD;AAED,gFAAgF;AAChF,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAoCvE;AAsCD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEvD;AAqND;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAAC,OAAO,EAAE;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC,GAAG,OAAO,CAAC,4BAA4B,CAAC,CA8ExC"}
+{"version":3,"file":"fumadocs.d.ts","sourceRoot":"","sources":["../../../../src/commands/docs/nav/fumadocs.ts"],"names":[],"mappings":"AAoBA;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,mEAAmE;IACnE,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;;OAGG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;;OAGG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAOD,eAAO,MAAM,mBAAmB,EAAE,WAAW,CAAC,MAAM,CAGlD,CAAC;AACH,eAAO,MAAM,kBAAkB,QACoB,CAAC;AACpD,eAAO,MAAM,aAAa,QAC6D,CAAC;AAmDxF;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQxD;AAED,gFAAgF;AAChF,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAoCvE;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CACrB,QAAQ,EAAE,MAAM,EAChB,YAAY,GAAE,WAAW,CAAC,MAAM,CAAa,GAC5C,MAAM,CAgBR;AAYD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEvD;AAOD;;;;;;;;;GASG;AACH;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GACvC,OAAO,CAUT;AA8KD;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAAC,OAAO,EAAE;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC,GAAG,OAAO,CAAC,4BAA4B,CAAC,CA8ExC"}

package/dist/commands/docs/nav/fumadocs.js

@@ -10,9 +10,12 @@ const GROUP_FOLDER = /^\(.+\)$/;
 // The `pages` item grammar of the fumadocs-core 16.10.2 page-tree builder
 // (`resolveFolderItem`): exact rest entries, separators, links, and the
 // exclude and extract prefixes are checked before an item is read as a path.
-const FUMADOCS_REST_ITEMS = new Set(['...', 'z...a']);
-const FUMADOCS_SEPARATOR = /^---(?:\[(?<icon>[^\]]+)])?(?<name>.+)---|^---$/;
-const FUMADOCS_LINK = /^(?<external>external:)?(?:\[(?<icon>[^\]]+)])?\[(?<name>[^\]]+)]\((?<url>[^)]+)\)$/;
+export const FUMADOCS_REST_ITEMS = new Set([
+    '...',
+    'z...a',
+]);
+export const FUMADOCS_SEPARATOR = /^---(?:\[(?<icon>[^\]]+)])?(?<name>.+)---|^---$/;
+export const FUMADOCS_LINK = /^(?<external>external:)?(?:\[(?<icon>[^\]]+)])?\[(?<name>[^\]]+)]\((?<url>[^)]+)\)$/;
 const FUMADOCS_PREFIXES = ['!', '...'];
 const H1 = /^#\s+(.+?)\s*#*\s*$/;
 const FENCE = /^\s*(```|~~~)/;
@@ -104,7 +107,7 @@ export function resolveFolderTitle(markdown) {
  * slugs plugin with the scaffolded `baseUrl: '/'`: group folders are dropped,
  * segments are URI-encoded, and an `index` file maps to its folder.
  */
-function pageUrl(pagePath, nonIndexUrls = new Set()) {
+export function pageUrl(pagePath, nonIndexUrls = new Set()) {
     const slugs = parentDir(pagePath)
         .split('/')
         .filter((segment) => segment.length > 0 && segment !== '.')
@@ -160,7 +163,7 @@ function hrefFragment(href) {
  * and no `pagesIndex` names a different page. Otherwise the page is shown
  * only if `pages` lists it.
  */
-function hasImplicitIndex(relativeDir, existing) {
+export function hasImplicitIndex(relativeDir, existing) {
     if (relativeDir === '.' ||
         existing?.root === true ||
         (typeof existing?.root === 'string' && existing.root.trim().length > 0)) {

package/dist/commands/docs/nav/membership.d.ts

@@ -0,0 +1,37 @@
+import { type FumadocsMetaFile } from './fumadocs.js';
+/**
+ * One way a hand-authored (or undeclared) sidebar disagrees with the authored
+ * Contents maps. The comparison checks membership and relative order only:
+ * separators, labels, link items, rest entries and pages borrowed from another
+ * folder are the author's presentation and are never compared with generator
+ * output.
+ */
+export interface NavMembershipIssue {
+    /** Content-relative path of the meta.json, or `mkdocs.yml`. */
+    path: string;
+    kind: 'missing' | 'dangling' | 'order' | 'malformed' | 'unreadable';
+    message: string;
+    line?: number;
+}
+/**
+ * Compare present Fumadocs `meta.json` files with the Contents-derived
+ * expectation in `metaFiles` (from a `check` run of nav sync).
+ *
+ * A Contents entry is reachable when its folder's `pages` lists it, a rest
+ * entry shows it, any other `pages` entry borrows it, or a root-relative link
+ * item points at its URL. An absent meta.json or one without `pages` uses the
+ * loader's folder order and is skipped.
+ */
+export declare function compareFumadocsMembership(docsRoot: string, metaFiles: readonly FumadocsMetaFile[]): Promise<NavMembershipIssue[]>;
+/**
+ * Compare a hand-authored MkDocs `nav:` with the Contents maps: every
+ * Contents page appears, every local nav page exists, and the entries of
+ * each Contents map (pages and section landing pages) keep their order. Section labels, nesting and external
+ * links are the author's. Returns no issues when `nav` is absent.
+ */
+export declare function compareMkDocsMembership(options: {
+    appRoot: string;
+    docsRoot: string;
+    nonReaderPaths?: readonly string[];
+}): Promise<NavMembershipIssue[]>;
+//# sourceMappingURL=membership.d.ts.map

package/dist/commands/docs/nav/membership.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"membership.d.ts","sourceRoot":"","sources":["../../../../src/commands/docs/nav/membership.ts"],"names":[],"mappings":"AAMA,OAAO,EAML,KAAK,gBAAgB,EACtB,MAAM,YAAY,CAAC;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,YAAY,CAAC;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAqHD;;;;;;;;GAQG;AACH,wBAAsB,yBAAyB,CAC7C,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,SAAS,gBAAgB,EAAE,GACrC,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAoS/B;AAeD;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAAC,OAAO,EAAE;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAwEhC"}