How does it handle code examples?

Examples are written in a standalone example.ts file and then referenced in the markdown using the '{@include ...}' tag with specific line ranges to ensure code remains testable and clean.

Does it support complex TypeScript patterns?

Yes, it is specifically designed to handle classic call styles, curried versions, and predicate overloads, providing specific templates for each.

What namespaces are supported?

It supports standard DuploJS namespaces including Array (A), Clean (C), DataParser (DP/DPE), and handles common utilities that don't require a namespace prefix.

What file structure does this skill follow?

It organizes documentation under the 'jsDoc/{namespace}/{function}/' directory, creating an index.md for the core content and an example.ts for code samples.

DuploJS JSDoc Writer

Name: DuploJS JSDoc Writer
Author: duplojs

byduplojs

•

Learning & Documentation

Generates and updates standardized JSDoc documentation and TypeScript examples for the DuploJS utility ecosystem.

About

The writeJsDoc skill automates the creation and maintenance of specialized JSDoc documentation for the DuploJS toolbox. It ensures consistency across the library by enforcing a strict directory structure and markdown format, including specific sections for function descriptions, call styles, and behavior. The skill intelligently manages TypeScript code examples by maintaining separate source files and referencing them via include tags, while providing specialized support for modern patterns like curried functions and predicate overloads.

Key Features

Automated JSDoc markdown generation based on standard project templates.
Built-in support for documenting classic, curried, and predicate function overloads.
Integrated @include tag management with precise line-start and line-end referencing.
Automated namespace organization for Array, Clean, DataParser, and Common domains.
11 GitHub stars
Synchronized management of index.md structure and example.ts source files.

Use Cases

Documenting new utility functions added to the @duplojs/utils library.
Updating existing documentation to include new curried or predicate usage patterns.
Standardizing documentation folders for internal contributors in the DuploJS ecosystem.

About

Key Features

Automated JSDoc markdown generation based on standard project templates.
Built-in support for documenting classic, curried, and predicate function overloads.
Integrated @include tag management with precise line-start and line-end referencing.
Automated namespace organization for Array, Clean, DataParser, and Common domains.
11 GitHub stars
Synchronized management of index.md structure and example.ts source files.

Use Cases

Documenting new utility functions added to the @duplojs/utils library.
Updating existing documentation to include new curried or predicate usage patterns.
Standardizing documentation folders for internal contributors in the DuploJS ecosystem.