fusion-package-scribe

Automate TSDoc generation by sweeping a TypeScript monorepo to discover public exports and add summary lines, @param, @returns, and @example tags. The process avoids name-echo anti-patterns while preserving existing valuable documentation.

Standardize README files by rewriting them into a consistent, retrieval-friendly structure optimized for discoverability. An automated review council validates the standardized README content before committing documentation-only changes per package.

Git CLI access is required to generate TypeScript package documentation, as the process produces documentation-only commits per package. Filesystem access is also needed to discover packages, barrel exports, and apply TSDoc improvements.

Single-package TSDoc improvement passes are supported by targeting a specific package directory like packages/utils/observable. This generates or improves TSDoc and rewrites its README, committing documentation-only changes scoped to that package.

TypeScript package APIs are hard to discover in semantic search when TSDoc comments and READMEs are inconsistent or missing. Standardizing TSDoc on public exports and rewriting READMEs to a retrieval-friendly structure surfaces APIs for reuse and onboarding.

Generating TSDoc preserves valuable existing documentation while improving or adding missing comments. The process enhances public exports with meaningful summary lines and tags without blindly overwriting previously written documentation.