@guiho/xdocs 0.3.1 → 0.4.2

package/library/tree.d.ts

@@ -2,7 +2,7 @@
  * @copyright Copyright (c) 2026 GUIHO Technologies as represented by Cristóvão GUIHO. All Rights Reserved.
  */
 import type { XDocsFile, XDocsTreeNode, XDocsTreeValidation } from './types.js';
-/** Build a hierarchy tree from a list of xdocs files. */
+/** Build a hierarchy tree from a list of xdocs descriptors. */
 export declare const buildTree: (files: XDocsFile[]) => XDocsTreeNode;
 /** Validate tree integrity. */
 export declare const validateTree: (files: XDocsFile[]) => XDocsTreeValidation;

package/library/tree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tree.d.ts","sourceRoot":"","sources":["../source/tree.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAE/E,yDAAyD;AACzD,eAAO,MAAM,SAAS,GAAI,OAAO,SAAS,EAAE,KAAG,aA8D9C,CAAA;AAED,+BAA+B;AAC/B,eAAO,MAAM,YAAY,GAAI,OAAO,SAAS,EAAE,KAAG,mBAmCjD,CAAA;AAED,gDAAgD;AAChD,eAAO,MAAM,UAAU,GAAI,MAAM,aAAa,EAAE,eAAU,KAAG,MAe5D,CAAA;AAED,iCAAiC;AACjC,eAAO,MAAM,kBAAkB,GAAI,MAAM,aAAa,EAAE,eAAU,KAAG,MAWpE,CAAA"}
+{"version":3,"file":"tree.d.ts","sourceRoot":"","sources":["../source/tree.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAE/E,+DAA+D;AAC/D,eAAO,MAAM,SAAS,GAAI,OAAO,SAAS,EAAE,KAAG,aA8D9C,CAAA;AAED,+BAA+B;AAC/B,eAAO,MAAM,YAAY,GAAI,OAAO,SAAS,EAAE,KAAG,mBAmCjD,CAAA;AAED,gDAAgD;AAChD,eAAO,MAAM,UAAU,GAAI,MAAM,aAAa,EAAE,eAAU,KAAG,MAe5D,CAAA;AAED,iCAAiC;AACjC,eAAO,MAAM,kBAAkB,GAAI,MAAM,aAAa,EAAE,eAAU,KAAG,MAWpE,CAAA"}

package/library/tree.js

@@ -1,7 +1,7 @@
 /**
  * @copyright Copyright (c) 2026 GUIHO Technologies as represented by Cristóvão GUIHO. All Rights Reserved.
  */
-/** Build a hierarchy tree from a list of xdocs files. */
+/** Build a hierarchy tree from a list of xdocs descriptors. */
 export const buildTree = (files) => {
     const nodeMap = new Map();
     // Create nodes for every file with valid metadata
@@ -47,7 +47,7 @@ export const buildTree = (files) => {
     if (!root) {
         root = {
             subject: '(root)',
-            description: 'No root xdocs file found.',
+            description: 'No root xdocs descriptor found.',
             path: null,
             children: [...nodeMap.values()].filter((node) => !files.some((f) => f.metadata && f.metadata.children.includes(node.subject))),
         };

package/library/types.d.ts

@@ -61,23 +61,33 @@ export type XDocsAgentSettings = {
     autoSkillInstall: boolean;
     skillTool: XDocsAgentTool;
 };
-/** YAML frontmatter metadata from an xdocs file. */
+/** YAML frontmatter metadata from an xdocs descriptor. */
 export type XDocsMetadata = {
     subject: string;
     description: string;
     parent: string | null;
     children: string[];
     files: Record<string, string>;
+    documents: Record<string, string>;
     tags: string[];
+    keywords: string[];
     flags: string[];
     status?: string;
 };
-/** A discovered xdocs file with its path and parsed metadata. */
+/** A sibling Markdown document listed by a module descriptor. */
+export type XDocsMarkdownDocument = {
+    path: string;
+    relativePath: string;
+    directory: string;
+    name: string;
+};
+/** A discovered xdocs descriptor with its path and parsed metadata. */
 export type XDocsFile = {
     path: string;
     relativePath: string;
     directory: string;
     metadata: XDocsMetadata | null;
+    documents: XDocsMarkdownDocument[];
     body: string;
     valid: boolean;
     errors: string[];
@@ -112,9 +122,11 @@ export type XDocsCliOptions = {
 export type XDocsScanResult = {
     totalFiles: number;
     totalDirectories: number;
+    totalMarkdownDocuments: number;
     coveredDirectories: number;
     uncoveredDirectories: number;
     xdocsFiles: XDocsFile[];
+    markdownDocuments: XDocsMarkdownDocument[];
     uncoveredPaths: string[];
 };
 /** Available prompt names for xdocs prompt --name. */

package/library/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../source/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAA;AAEtD,kDAAkD;AAClD,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,MAAM,CAAA;AAE3C,2CAA2C;AAC3C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEzG;;;;iCAIiC;AACjC,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAEhD,4CAA4C;AAC5C,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEhD,0DAA0D;AAC1D,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,OAAO,CAAC;QAClB,SAAS,EAAE,MAAM,EAAE,CAAA;KACpB,CAAC,CAAA;IACF,EAAE,EAAE,OAAO,CAAC;QACV,IAAI,EAAE,MAAM,CAAA;KACb,CAAC,CAAA;IACF,IAAI,EAAE,OAAO,CAAC;QACZ,OAAO,EAAE,MAAM,EAAE,CAAA;KAClB,CAAC,CAAA;IACF,OAAO,EAAE,OAAO,CAAC;QACf,IAAI,EAAE,MAAM,CAAA;KACb,CAAC,CAAA;IACF,MAAM,EAAE,OAAO,CAAC;QACd,cAAc,EAAE,OAAO,CAAA;QACvB,kBAAkB,EAAE,OAAO,CAAA;QAC3B,UAAU,EAAE,MAAM,CAAA;KACnB,CAAC,CAAA;CACH,CAAC,CAAA;AAEF,2CAA2C;AAC3C,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,CAAC,CAAA;IACT,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE;QACV,SAAS,EAAE,MAAM,EAAE,CAAA;KACpB,CAAA;IACD,EAAE,EAAE;QACF,IAAI,EAAE,WAAW,CAAA;KAClB,CAAA;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,EAAE,CAAA;KAClB,CAAA;IACD,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD,MAAM,EAAE,kBAAkB,CAAA;CAC3B,CAAA;AAED,4CAA4C;AAC5C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,EAAE,OAAO,CAAA;IACrB,gBAAgB,EAAE,OAAO,CAAA;IACzB,SAAS,EAAE,cAAc,CAAA;CAC1B,CAAA;AAED,oDAAoD;AACpD,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,QAAQ,EAAE,aAAa,EAAE,CAAA;CAC1B,CAAA;AAED,wCAAwC;AACxC,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,OAAO,CAAA;IACd,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,4BAA4B;AAC5B,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,CAAC,CAAA;CACnD,CAAA;AAED,0DAA0D;AAC1D,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,WAAW,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED,sDAAsD;AACtD,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAA;AAExE,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,uEAAuE;AACvE,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,cAAc,CAAA;IACpB,KAAK,EAAE,eAAe,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,kBAAkB,EAAE,MAAM,EAAE,CAAA;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,gEAAgE;AAChE,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,gFAAgF;AAChF,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,EAAE,kBAAkB,CAAA;IAC5B,QAAQ,CAAC,EAAE,6BAA6B,CAAA;IACxC,WAAW,CAAC,EAAE,uBAAuB,CAAA;CACtC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../source/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,iDAAiD;AACjD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAA;AAEtD,kDAAkD;AAClD,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,MAAM,CAAA;AAE3C,2CAA2C;AAC3C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEzG;;;;iCAIiC;AACjC,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAEhD,4CAA4C;AAC5C,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEhD,0DAA0D;AAC1D,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,OAAO,CAAC;QAClB,SAAS,EAAE,MAAM,EAAE,CAAA;KACpB,CAAC,CAAA;IACF,EAAE,EAAE,OAAO,CAAC;QACV,IAAI,EAAE,MAAM,CAAA;KACb,CAAC,CAAA;IACF,IAAI,EAAE,OAAO,CAAC;QACZ,OAAO,EAAE,MAAM,EAAE,CAAA;KAClB,CAAC,CAAA;IACF,OAAO,EAAE,OAAO,CAAC;QACf,IAAI,EAAE,MAAM,CAAA;KACb,CAAC,CAAA;IACF,MAAM,EAAE,OAAO,CAAC;QACd,cAAc,EAAE,OAAO,CAAA;QACvB,kBAAkB,EAAE,OAAO,CAAA;QAC3B,UAAU,EAAE,MAAM,CAAA;KACnB,CAAC,CAAA;CACH,CAAC,CAAA;AAEF,2CAA2C;AAC3C,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,CAAC,CAAA;IACT,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE;QACV,SAAS,EAAE,MAAM,EAAE,CAAA;KACpB,CAAA;IACD,EAAE,EAAE;QACF,IAAI,EAAE,WAAW,CAAA;KAClB,CAAA;IACD,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,EAAE,CAAA;KAClB,CAAA;IACD,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD,MAAM,EAAE,kBAAkB,CAAA;CAC3B,CAAA;AAED,4CAA4C;AAC5C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,YAAY,EAAE,OAAO,CAAA;IACrB,gBAAgB,EAAE,OAAO,CAAA;IACzB,SAAS,EAAE,cAAc,CAAA;CAC1B,CAAA;AAED,0DAA0D;AAC1D,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACjC,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,uEAAuE;AACvE,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAA;IAC9B,SAAS,EAAE,qBAAqB,EAAE,CAAA;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,QAAQ,EAAE,aAAa,EAAE,CAAA;CAC1B,CAAA;AAED,wCAAwC;AACxC,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,OAAO,CAAA;IACd,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,MAAM,EAAE,MAAM,EAAE,CAAA;CACjB,CAAA;AAED,4BAA4B;AAC5B,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,WAAW,EAAE,MAAM,EAAE,CAAA;IACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,CAAC,CAAA;CACnD,CAAA;AAED,0DAA0D;AAC1D,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,WAAW,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,sBAAsB,EAAE,MAAM,CAAA;IAC9B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,UAAU,EAAE,SAAS,EAAE,CAAA;IACvB,iBAAiB,EAAE,qBAAqB,EAAE,CAAA;IAC1C,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AAED,sDAAsD;AACtD,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAA;AAExE,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,uEAAuE;AACvE,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,cAAc,CAAA;IACpB,KAAK,EAAE,eAAe,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,kBAAkB,EAAE,MAAM,EAAE,CAAA;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,gEAAgE;AAChE,MAAM,MAAM,6BAA6B,GAAG;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,OAAO,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,gFAAgF;AAChF,MAAM,MAAM,0BAA0B,GAAG;IACvC,QAAQ,EAAE,kBAAkB,CAAA;IAC5B,QAAQ,CAAC,EAAE,6BAA6B,CAAA;IACxC,WAAW,CAAC,EAAE,uBAAuB,CAAA;CACtC,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@guiho/xdocs",
   "description": "Structured documentation system for codebases. Helps AI make sense of projects.",
-  "version": "0.3.1",
+  "version": "0.4.2",
   "type": "module",
   "main": "./library/guiho-xdocs.js",
   "types": "./library/guiho-xdocs.d.ts",
@@ -40,6 +40,9 @@
     "url": "https://guiho.co/cg"
   },
   "sideEffects": false,
+  "trustedDependencies": [
+    "@guiho/mirror"
+  ],
   "publishConfig": {
     "access": "public"
   },

package/prompts/agents.md

@@ -1,6 +1,10 @@
 ---
 name: agents
 description: Update AGENTS.md with xdocs instructions for AI agents.
+keywords:
+  - AGENTS.md
+  - agent instructions
+  - xdocs skill
 ---
 
 # xdocs: Update AGENTS.md
@@ -14,8 +18,11 @@ You are an AI assistant tasked with updating the AGENTS.md file to include xdocs
 3. If the section exists, update it with the current xdocs configuration.
 4. If the section does not exist, add it at the end of the file.
 5. The xdocs section should instruct AI agents to:
-   - Read XDOCS.md and xdocs files when entering the project
+   - Read XDOCS.md and named `*.xdocs.md` descriptor files when entering the project
    - Respect the configured AI behavior mode (prompt or auto)
    - Use the xdocs CLI for documentation operations
-   - Maintain xdocs files when modifying code
+   - Maintain xdocs descriptors and companion-document metadata when modifying code
+   - Use only named `*.xdocs.md` descriptors, never nameless `.xdocs.md` files
+   - List every same-directory plain `*.md` companion document in the descriptor's `documents` metadata map
+   - Maintain `keywords` in both descriptor and companion Markdown frontmatter
    - Follow the metadata schema for frontmatter

package/prompts/generate.md

@@ -1,6 +1,10 @@
 ---
 name: generate
 description: Generate comprehensive documentation for a domain or entire project.
+keywords:
+  - generate documentation
+  - comprehensive docs
+  - project summary
 ---
 
 # xdocs: Generate Comprehensive Documentation
@@ -9,18 +13,22 @@ You are an AI assistant tasked with generating comprehensive documentation for a
 
 ## Instructions
 
-1. Scan all xdocs files in the target scope (directory or project).
-2. Read every source file in the scope.
+1. Scan all xdocs descriptors in the target scope (directory or project).
+2. Read every named `*.xdocs.md` descriptor's YAML frontmatter first, then read
+   source files and same-directory plain `*.md` documents only when needed.
 3. Build a complete understanding of:
    - The module hierarchy
    - The purpose of each module
    - How modules relate to each other
    - What each file does
+   - Which companion Markdown documents belong to each module
+   - Which keywords identify each module and companion document
 4. Generate a single comprehensive Markdown document that includes:
    - Project or domain overview
    - Complete hierarchy tree
    - Detailed description of each module
    - File listings with descriptions
+   - Companion document listings with descriptions
    - Cross-references between related modules
 5. The output should be a self-contained document that fully describes the scope.
 6. Use clear headings, consistent formatting, and concise language.

package/prompts/prompts.xdocs.md

@@ -0,0 +1,27 @@
+---
+subject: xdocs-prompts
+description: Runtime prompt templates used by xdocs prompt commands and embedded into native binaries.
+parent: xdocs-package
+children: []
+files: {}
+documents:
+  agents.md: Prompt for updating AGENTS.md with xdocs instructions.
+  generate.md: Prompt for generating comprehensive documentation from xdocs metadata.
+  update.md: Prompt for updating existing xdocs descriptors after code or document changes.
+  write.md: Prompt for writing a named xdocs descriptor for a module.
+tags:
+  - prompts
+  - ai
+  - documentation
+keywords:
+  - prompts
+  - AI instructions
+  - documentation generation
+flags: []
+status: stable
+---
+
+The `prompts/` directory contains Markdown prompt templates loaded by
+`source/prompts.ts` at runtime and embedded by `source/embedded-resources.ts` for
+native binaries. They are plain companion documents, so this descriptor lists
+each prompt under `documents`.

package/prompts/update.md

@@ -1,6 +1,10 @@
 ---
 name: update
-description: Update existing xdocs files after code changes.
+description: Update existing xdocs descriptors after code or document changes.
+keywords:
+  - update descriptor
+  - synchronize metadata
+  - documentation maintenance
 ---
 
 # xdocs: Update Documentation
@@ -10,22 +14,30 @@ You are an AI assistant tasked with updating existing xdocs documentation after
 ## Instructions
 
 1. Identify which files have changed in the recent modifications.
-2. Find the xdocs files that document the directories containing those changes.
-3. For each affected xdocs file:
+2. Find the named `*.xdocs.md` descriptor files that document the directories
+   containing those changes. There must be exactly one descriptor per directory,
+   and it must not be named only `.xdocs.md`.
+3. For each affected xdocs descriptor:
    a. Re-read the files listed in the metadata to check if descriptions are still accurate.
    b. Check if new files were added that need to be listed.
    c. Check if files were removed that should be unlisted.
-   d. Update the description if the module's purpose has changed.
-   e. Update children if subdirectories were added or removed.
-   f. Update the body content if significant changes occurred.
-4. Preserve the existing structure and style of the xdocs file.
+   d. Check if sibling plain `*.md` documents were added or removed, and keep
+      the `documents` metadata map exact.
+   e. Update the description if the module's purpose has changed.
+   f. Update `keywords` if the module's searchable concepts changed.
+   g. Update children if subdirectories were added or removed.
+   h. Update the body content if significant changes occurred.
+4. Preserve the existing structure and style of the xdocs descriptor.
 5. Do not remove information that is still accurate.
 
 ## Checklist
 
 - [ ] All new files are listed in the files metadata
 - [ ] Removed files are no longer listed
+- [ ] All sibling plain Markdown documents are listed in the documents metadata
+- [ ] Removed Markdown documents are no longer listed
 - [ ] File descriptions are accurate
 - [ ] Module description reflects current state
+- [ ] Keywords reflect current searchable concepts
 - [ ] Children list matches actual subdirectories
 - [ ] Parent reference is still correct

package/prompts/write.md

@@ -1,6 +1,10 @@
 ---
 name: write
-description: Scan a directory and write a new xdocs documentation file for it.
+description: Scan a directory and write a new named xdocs descriptor for it.
+keywords:
+  - write descriptor
+  - xdocs metadata
+  - module documentation
 ---
 
 # xdocs: Write Documentation
@@ -12,19 +16,25 @@ You are an AI assistant tasked with writing xdocs documentation for a directory/
 1. Scan the target directory and all its subdirectories.
 2. Read every source file to understand what it does.
 3. Identify the purpose of this module/directory.
-4. Create an xdocs file with YAML frontmatter containing:
+4. Create a named xdocs descriptor with YAML frontmatter containing:
    - subject: A short identifier for this module
    - description: A concise description of what this module does
    - parent: The parent module's subject (or null if this is a root module)
    - children: List of child module subjects
    - files: Map of filename to short description for each file
+   - documents: Map of same-directory plain Markdown filename to short description
    - tags: Relevant tags (empty array if none)
+   - keywords: Search terms and concepts that should help agents match requests
    - flags: Relevant flags (empty array if none)
 5. Write a Markdown body below the frontmatter with:
    - An overview section explaining the module in more detail
    - Usage examples if relevant
    - Any important notes or caveats
-6. Name the file as `<module-name>.xdocs.md` in the target directory.
+6. Name the file as `<module-name>.xdocs.md` in the target directory. Never name
+   a file only `.xdocs.md`; `.xdocs.md` is the extension, not the full filename.
+7. Use only `.xdocs.md` for xdocs descriptors. Do not create `.docs.md` files.
+8. If the directory contains sibling plain `*.md` files, list each one under
+   `documents` in this descriptor.
 
 ## Frontmatter Template
 
@@ -37,9 +47,12 @@ children:
   - child-a
   - child-b
 files:
-  - file-a.ts: What file-a does.
-  - file-b.ts: What file-b does.
+  file-a.ts: What file-a does.
+  file-b.ts: What file-b does.
+documents:
+  implementation-notes.md: What this companion document explains.
 tags: []
+keywords: []
 flags: []
 ---
 ```

package/scripts/scripts.xdocs.md

@@ -6,10 +6,15 @@ children: []
 files:
   xdocs-bin.ts: Shipped Bun launcher used as the package bin; installs the native binary on first run when needed and delegates to it.
   install-package.ts: Package-manager install helper that downloads or copies the matching GitHub Release native binary into vendor/xdocs or vendor/xdocs.exe.
+documents: {}
 tags:
   - install
   - native-binary
   - package-manager
+keywords:
+  - package launcher
+  - native binary
+  - vendor install
 flags: []
 status: stable
 ---

package/skills/guiho-s-xdocs/SKILL.md

@@ -1,15 +1,30 @@
 ---
 name: guiho-s-xdocs
-version: 0.3.0
-description: Use this skill whenever the user works with xdocs (`@guiho/xdocs`) structured documentation, AND proactively whenever you create a new module or subdirectory or add/change/remove files in a directory of an xdocs project, so you create or update that directory's `.xdocs.md` as part of the change. This includes creating, updating, or regenerating `.docs.md` / `.xdocs.md` files, the root `XDOCS.md`, the project tree, scanning documentation coverage, merging docs, or maintaining xdocs metadata and AGENTS.md guidance, even when the user only says "document this module", "update the docs", or "what does this folder do" without naming xdocs.
+version: 0.4.0
+purpose: Teach AI agents how to maintain xdocs descriptor files, companion Markdown documents, metadata, and tree integrity.
+description: Use this skill whenever the user works with xdocs (`@guiho/xdocs`) structured documentation, AND proactively whenever you create a new module or subdirectory or add/change/remove files in a directory of an xdocs project, so you create or update that directory's named `*.xdocs.md` descriptor as part of the change. This includes creating, updating, or regenerating `*.xdocs.md` descriptor files, companion Markdown documents, the root `XDOCS.md`, the project tree, scanning documentation coverage, merging docs, or maintaining xdocs metadata and AGENTS.md guidance, even when the user only says "document this module", "update the docs", or "what does this folder do" without naming xdocs.
+created: 2026-07-06
+flags:
+  - automatic-documentation-maintenance
+  - companion-document-metadata
+tags:
+  - xdocs
+  - documentation
+  - agents
+keywords:
+  - xdocs
+  - structured documentation
+  - companion documents
+  - agent workflow
+owner: xdocs-guiho-s-xdocs-skill
 ---
 
 # GUIHO XDocs
 
-GUIHO XDocs is a deterministic CLI and TypeScript library for **structured documentation of codebases**. It lets an AI agent understand a project without reading every source file: each directory carries a small Markdown file with YAML frontmatter that describes its subject, purpose, files, and place in a parent-child hierarchy.
+GUIHO XDocs is a deterministic CLI and TypeScript library for **structured documentation of codebases**. It lets an AI agent understand a project without reading every source file: each documented directory carries one named `*.xdocs.md` descriptor with YAML frontmatter that describes its subject, purpose, files, companion Markdown documents, and place in a parent-child hierarchy.
 
 ```text
-source tree -> xdocs files (.docs.md / .xdocs.md) -> tree + metadata -> AI-readable map
+source tree -> named *.xdocs.md descriptors + companion *.md documents -> tree + metadata -> AI-readable map
 ```
 
 Use xdocs for documentation work instead of ad hoc README sprawl or re-reading the whole codebase. The value of xdocs is that the structure (subjects, descriptions, files, parent/child links) is machine-readable and stays close to the code it describes.
@@ -28,15 +43,16 @@ xdocs is a Bun/TypeScript ESM tool. Bun is the recommended runtime. The CLI neve
 
 ## Core Concepts
 
-- **xdocs file**: a Markdown file with YAML frontmatter that documents one directory/module. Default extensions are `.docs.md` and `.xdocs.md`. Extensions are configurable in `xdocs.config.toml`.
+- **xdocs descriptor**: a named Markdown file ending in `.xdocs.md` with YAML frontmatter that documents one directory/module. There is exactly one descriptor per documented directory. The file must have a name such as `authentication.xdocs.md`; a file named only `.xdocs.md` is invalid.
+- **Companion document**: a same-directory plain Markdown file ending in `.md` but not `.xdocs.md` and not `XDOCS.md`. Every companion document must be listed in the descriptor's `documents` metadata map, and ordinary companion documents should carry their own YAML frontmatter with `name`, `purpose`, `description`, `created`, `flags`, `tags`, `keywords`, and `owner`.
 - **Repository root index**: there is exactly one `XDOCS.md` per repository, at the repo root. It has **no frontmatter** — it is a plain index that lists the repository's packages and applications, and it is not itself a tree node.
 - **Package/application root**: each package or application has its own root `.xdocs.md` file (with frontmatter and `parent: null`) that is the top of that package's documentation tree. `XDOCS.md` lists these package roots.
-- **Tree**: a parent-child **containment** hierarchy (not a dependency graph), assembled from each `.xdocs.md` / `.docs.md` file's `subject` / `parent` / `children` fields. A module's `parent` is the `subject` of the module that contains it; a package/application root uses `parent: null`.
+- **Tree**: a parent-child **containment** hierarchy (not a dependency graph), assembled from each `.xdocs.md` descriptor's `subject` / `parent` / `children` fields. A module's `parent` is the `subject` of the module that contains it; a package/application root uses `parent: null`.
 - **AI mode**: `xdocs.config.toml` `[ai].mode` is either `"prompt"` (announce the documentation updates, then write them) or `"auto"` (write immediately). It governs *how* you write docs, not *whether* — documenting a changed module is always required (see Automatic Documentation Maintenance).
 
 ### Metadata schema (YAML frontmatter)
 
-Every `.xdocs.md` / `.docs.md` file carries frontmatter with these fields. The repository's single `XDOCS.md` is the exception: it has no frontmatter and is just an index.
+Every `*.xdocs.md` descriptor carries frontmatter with these fields. The repository's single `XDOCS.md` is the exception: it has no frontmatter and is just an index.
 
 | Field         | Type                  | Meaning                                                       |
 | ------------- | --------------------- | ------------------------------------------------------------ |
@@ -45,29 +61,74 @@ Every `.xdocs.md` / `.docs.md` file carries frontmatter with these fields. The r
 | `parent`      | string \| null        | `subject` of the containing module; `null` for a package/application root. |
 | `children`    | string[]              | `subject`s of directly contained modules.                    |
 | `files`       | map<string,string>    | Filename -> short description of each significant file.      |
+| `documents`   | map<string,string>    | Same-directory plain Markdown filename -> short description. |
 | `tags`        | string[]              | Free-form classification labels.                             |
+| `keywords`    | string[]              | Search terms and concepts agents can use to match requests.  |
 | `flags`       | string[]              | Behavioral markers for tools/agents.                         |
 | `status`      | string (optional)     | Lifecycle marker (e.g. `stable`, `draft`, `deprecated`).     |
 
-Keep `subject` values unique across the project, keep `parent`/`children` consistent in both directions, and keep `files` in sync with what is actually on disk.
+Keep `subject` values unique across the project, keep `parent`/`children` consistent in both directions, keep `files` in sync with implementation files, and keep `documents` in sync with same-directory plain Markdown files.
+
+### Companion document metadata (YAML frontmatter)
+
+Ordinary same-directory companion Markdown documents also use YAML frontmatter.
+This metadata makes the document useful before an agent reads the whole body.
+The `owner` field must be the `subject` of the same-directory xdocs descriptor
+that owns the document.
+
+```yaml
+---
+name: authentication-implementation
+purpose: Explain the implementation details and decisions behind authentication.
+description: Detailed notes for login, password verification, and session behavior.
+created: 2026-07-06
+flags: []
+tags:
+  - security
+keywords:
+  - login
+  - password verification
+  - sessions
+owner: auth
+---
+```
+
+Companion document fields:
+
+| Field         | Type       | Meaning                                                        |
+| ------------- | ---------- | -------------------------------------------------------------- |
+| `name`        | string     | Stable document name or title.                                 |
+| `purpose`     | string     | Why this document exists and what question it answers.         |
+| `description` | string     | One-line summary of the document's contents.                   |
+| `created`     | string     | Creation date in `YYYY-MM-DD` format.                          |
+| `flags`       | string[]   | Behavioral markers for tools/agents.                           |
+| `tags`        | string[]   | Free-form classification labels.                               |
+| `keywords`    | string[]   | Search terms and concepts agents can use to match requests.    |
+| `owner`       | string     | Owning xdocs descriptor `subject` in the same directory.        |
+
+Special-purpose Markdown files that already have a required host schema, such
+as prompt templates or `SKILL.md`, must preserve their required host fields.
+When compatible, add the companion metadata fields as well.
 
 ## Automatic Documentation Maintenance (core responsibility)
 
-Maintaining xdocs files is an **automatic, built-in responsibility — not a task the user has to request.** Treat it as part of the definition of done for every code change in an xdocs project. The user should never have to ask you to document a module; you do it as a reflex whenever you touch one.
+Maintaining xdocs descriptors is an **automatic, built-in responsibility — not a task the user has to request.** Treat it as part of the definition of done for every code change in an xdocs project. The user should never have to ask you to document a module; you do it as a reflex whenever you touch one.
 
-**Trigger.** Whenever you, as the agent, do any of the following, you must create or update the affected directory's xdocs file in the *same unit of work*, before you consider the task finished:
+**Trigger.** Whenever you, as the agent, do any of the following, you must create or update the affected directory's named xdocs descriptor in the *same unit of work*, before you consider the task finished:
 
 - Create a new directory, module, or subpackage.
 - Add, rename, move, or delete significant files in a directory.
+- Add, rename, move, or delete sibling plain Markdown documents in a directory.
 - Change what a module does, what it exposes, or how it relates to its parent or children.
 
 **Action.**
 
-- If the directory has **no** xdocs file, create one (for example `<name>.xdocs.md`) in that directory.
-- If it **already** has one, update it so it matches the new reality.
+- If the directory has **no** xdocs descriptor, create one named `<name>.xdocs.md` in that directory.
+- If it **already** has one, update it so it matches the new reality. If there is more than one descriptor, consolidate to one.
+- Never create or keep a descriptor named only `.xdocs.md`. `.xdocs.md` is the extension, not the whole filename.
 - Then fix the parent/child links and verify with `<xdocs> tree`.
 
-**What every module's xdocs file must capture:**
+**What every module's xdocs descriptor must capture:**
 
 - `subject` — the module's unique name in the tree.
 - `description` — the module's **purpose**: what it is for and what it does.
@@ -75,12 +136,16 @@ Maintaining xdocs files is an **automatic, built-in responsibility — not a tas
 - `parent` — the `subject` of the containing module (and add this module to that parent's `children`).
 - `children` — the `subject`s of the modules contained inside this one.
 
-**Do not wait to be asked.** After you finish creating or modifying a module or directory, create or update its xdocs file as part of the same change. A code change that adds or alters a module is **not complete** until its xdocs file and the affected parent/child links are updated.
+Every descriptor also includes `documents`, a map from each same-directory plain Markdown filename to the purpose of that companion document.
+Each ordinary companion document listed there should include its own frontmatter
+with `owner` equal to this descriptor's `subject`.
+
+**Do not wait to be asked.** After you finish creating or modifying a module or directory, create or update its xdocs descriptor as part of the same change. A code change that adds or alters a module is **not complete** until its xdocs descriptor, companion-document list, and affected parent/child links are updated.
 
 **How `[ai].mode` applies.** The mode controls only *how* you write the docs, never *whether* you write them and never whether the user must ask first:
 
-- `auto` — create/update the xdocs files immediately as part of the change, then report what changed.
-- `prompt` — state exactly which xdocs files you are creating or updating, then write them (honoring any pending confirmation). Announcing is for transparency; it does not make documentation optional and the user never has to request it.
+- `auto` — create/update the xdocs descriptors immediately as part of the change, then report what changed.
+- `prompt` — state exactly which xdocs descriptors you are creating or updating, then write them (honoring any pending confirmation). Announcing is for transparency; it does not make documentation optional and the user never has to request it.
 
 ### Example: documenting a new module
 
@@ -95,8 +160,14 @@ children: []
 files:
   login.ts: Email/password login flow; exports `login()` and `verifyPassword()`.
   session.ts: Session lifecycle; exports `createSession()` and `validateSession()`.
+documents:
+  authentication-implementation.md: Companion notes that explain implementation details and decisions.
 tags:
   - security
+keywords:
+  - authentication
+  - login
+  - sessions
 flags: []
 status: stable
 ---
@@ -105,7 +176,31 @@ Auth validates credentials and issues sessions. `login()` delegates password
 checks to `verifyPassword()`; sessions are created and validated in `session.ts`.
 ```
 
-Then add `auth` to the `children` list of the `src` module's xdocs file so the tree stays consistent.
+Then create or update `src/auth/authentication-implementation.md` with
+companion-document frontmatter:
+
+```markdown
+---
+name: authentication-implementation
+purpose: Explain authentication implementation details and decisions.
+description: Detailed notes for login, password verification, and session behavior.
+created: 2026-07-06
+flags: []
+tags:
+  - security
+keywords:
+  - authentication
+  - password verification
+  - session lifecycle
+owner: auth
+---
+
+# Authentication Implementation
+
+Describe the implementation details that are too long for `auth.xdocs.md`.
+```
+
+Then add `auth` to the `children` list of the `src` module's xdocs descriptor so the tree stays consistent.
 
 If the directory you are documenting is the **root of a package or application** (not a sub-module), set `parent: null` instead, and list that package's root `.xdocs.md` in the repository's single `XDOCS.md` index rather than in a parent module's `children`.
 
@@ -115,23 +210,26 @@ When you start working in a project that uses xdocs:
 
 1. Read the root `XDOCS.md` to learn the project's top-level subject and structure.
 2. Run `<xdocs> tree` to see the module hierarchy.
-3. Run `<xdocs> scan` to see documentation coverage and which directories are missing xdocs files.
-4. Read `xdocs.config.toml` and note `[ai].mode`, the supported `[extensions]`, and `[scan].exclude`.
-5. When you navigate into a module, read that module's xdocs file (frontmatter first, body only if you need more) instead of reading every source file.
+3. Run `<xdocs> scan` to see documentation coverage, invalid descriptors, and companion-document coverage.
+4. Read `xdocs.config.toml` and note `[ai].mode` and `[scan].exclude`; xdocs descriptors always use the `.xdocs.md` suffix.
+5. When you navigate into a module, read that module's named `*.xdocs.md` descriptor frontmatter first. Read listed companion documents only when their descriptions show they are relevant.
 
 ## Documentation Workflow (writing and updating)
 
 Follow this whenever the automatic trigger above fires, or when the user asks to document a directory:
 
-1. Determine the target directory and whether it already has an xdocs file (`<xdocs> scan` or `<xdocs> list <path>`).
+1. Determine the target directory and whether it already has exactly one named `*.xdocs.md` descriptor (`<xdocs> scan` or `<xdocs> list <path>`).
 2. Read the directory's actual files so the documentation reflects reality. Never invent files, modules, or behavior that is not present.
 3. Respect `[ai].mode` (it controls how you write, not whether you write):
-   - **prompt mode**: state exactly which xdocs files you are creating or updating, then write them (honor a pending confirmation, but never skip the documentation).
-   - **auto mode**: create or update the xdocs files immediately, then report what changed.
-4. Write or update the xdocs file with correct frontmatter:
-   - Set `subject` (unique), `description` (the module's purpose), and `files` (each real file -> short purpose, including key functions/exports).
+   - **prompt mode**: state exactly which xdocs descriptors you are creating or updating, then write them (honor a pending confirmation, but never skip the documentation).
+   - **auto mode**: create or update the xdocs descriptors immediately, then report what changed.
+4. Write or update the xdocs descriptor with correct frontmatter:
+   - Set `subject` (unique), `description` (the module's purpose), and `files` (each real implementation/configuration file -> short purpose, including key functions/exports).
+   - Set `documents` to every same-directory plain Markdown file -> short purpose. Use `{}` when there are no companion documents.
+   - Set `keywords` to search terms and concepts that should help agents match user requests to the module.
+   - For each ordinary companion document, add or update frontmatter with `name`, `purpose`, `description`, `created`, `flags`, `tags`, `keywords`, and `owner`; set `owner` to the descriptor's `subject`.
    - Set `parent` to the containing module's `subject`, and add this `subject` to that parent's `children`.
-   - Use `tags`/`flags`/`status` where useful.
+   - Use `tags`/`keywords`/`flags`/`status` where useful.
 5. Keep the tree consistent: if you add a module, update its parent's `children`; if you remove one, update both sides.
 6. Validate with `<xdocs> tree` (it reports duplicate subjects, orphans, and missing children) and fix any reported issues.
 
@@ -150,7 +248,8 @@ When generating from scratch, prefer `<xdocs> generate <path>` (one directory) o
 
 ## Safety Rules
 
-- Never leave a new or changed module undocumented. Creating or updating its xdocs file is part of finishing the work, not a separate request the user must make.
+- Never leave a new or changed module undocumented. Creating or updating its xdocs descriptor is part of finishing the work, not a separate request the user must make.
+- Never leave an ordinary companion Markdown document without useful frontmatter; it should identify its `owner`, purpose, tags, keywords, and flags.
 - Never fabricate files, modules, descriptions, or relationships. Documentation must match the repository.
 - Never edit generated or build outputs (`library/`, `bundle/`, `bin/`, `*.tgz`). They are ignored and regenerated.
 - In prompt mode, announce the xdocs changes you will make and honor a pending confirmation — but still treat documenting the change as required, never optional.
@@ -166,7 +265,7 @@ xdocs searches for configuration via `--config <path>`, `./xdocs.config.toml`, o
 schema = 1
 
 [extensions]
-supported = [".docs.md", ".xdocs.md"]
+supported = [".xdocs.md"]
 
 [ai]
 mode = "prompt"            # "prompt" (announce and wait) or "auto" (update immediately)
@@ -185,15 +284,17 @@ skill_tool = "agents"      # default tool for auto-install: agents (standard) or
 
 Agent automation options default to true. A bare `xdocs` invocation and normal data commands always bootstrap the standard global skill when no config is present; with config, set `auto_agents_md = false` to stop xdocs from touching AGENTS.md, and `auto_skill_install = false` to stop xdocs from installing or refreshing `guiho-s-xdocs` globally.
 
+The `[extensions]` section is retained for config compatibility, but the only supported descriptor suffix is `.xdocs.md`.
+
 ## CLI Reference
 
 ```bash
 xdocs init                     # create XDOCS.md + xdocs.config.toml, update AGENTS.md, install the skill
-xdocs scan                     # report xdocs coverage across the project
+xdocs scan                     # report descriptor and companion-document coverage
 xdocs tree                     # print the module hierarchy
-xdocs list <path>              # list files in a scope with descriptions
+xdocs list <path>              # list files and companion documents with descriptions
 xdocs generate [path]          # draft documentation for a directory or the whole project
-xdocs merge [path]             # merge a directory's xdocs files into one document
+xdocs merge [path]             # merge a directory's xdocs descriptors into one document
 xdocs prompt --name=<name>     # print a ready-made AI prompt (write|update|agents|generate)
 xdocs agents install local     # install guiho-s-xdocs into this project (.agents/skills/...)
 xdocs agents install global    # install guiho-s-xdocs into the user home skills directory
@@ -252,7 +353,7 @@ await ensureAgentsInstructions(process.cwd(), true)
 When reporting an xdocs result, include:
 
 - The command that ran and the target path.
-- Which xdocs files were created or changed, if any.
+- Which xdocs descriptors and companion documents were created or changed, if any.
 - Tree/coverage status (subjects added, orphans or duplicates resolved).
 - The configured AI mode, and — in prompt mode — exactly what you are waiting to write.