write-js-doc

Official

Automate JSDoc updates for Playwright APIs.

Authorduplojs
Version1.0.0
Installs0

System Documentation

What problem does it solve?

JSDoc generation and maintenance for the public API of @duplojs/playwright, ensuring consistent, up-to-date documentation across exports and usage patterns.

Core Features & Use Cases

  • Inspect the current public export structure to determine whether the target symbol is a flat root export, a member of a grouped export, or an internal symbol that should not be documented yet.
  • Choose the right documentation path layout based on the actual export shape and apply bundled templates from assets.
  • Reuse the included templates (assets/index-template.md and assets/example-template.md) to produce uniform index and example docs and support {@include ...} annotations.
  • Provide guidance to ensure the documentation remains aligned with the real API surface and usage examples.

Quick Start

Run the skill to generate or update JSDoc for a specified public API symbol by detecting its export shape and applying the appropriate templates.

Dependency Matrix

Required Modules

None required

Components

assets

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: write-js-doc
Download link: https://github.com/duplojs/playwright/archive/main.zip#write-js-doc

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.