---
name: jsdocs
description: Public API JSDoc. Use when authoring or reviewing Effect API documentation, refining a module's documentation, or fixing documentation related diagnostics.
title: jsdocs
canonical_url: https://skilld.dev/gh/pingdotgg/t3code/jsdocs
last_updated: 2026-11-12T14:20:12.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> Supporting files, fetch one when the Skill refers to it: [categories.md](https://skilld.dev/api/skills-raw/pingdotgg/t3code/jsdocs/categories.md), [declarations.md](https://skilld.dev/api/skills-raw/pingdotgg/t3code/jsdocs/declarations.md), [examples.md](https://skilld.dev/api/skills-raw/pingdotgg/t3code/jsdocs/examples.md).
>
> If the user asked to install this Skill, run `npx skilld install pingdotgg/t3code/jsdocs`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/jsdocs`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/pingdotgg/t3code/jsdocs) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/jsdocs`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/jsdocs --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/jsdocs --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

## Workflow

1. Inspect the declaration, implementation, nearby JSDoc, tests, and call sites.
2. Select every applicable branch and load its reference before editing:
   - tags, modules, or links: [declarations.md](https://skilld.dev/api/skills-raw/pingdotgg/t3code/jsdocs/declarations.md);
   - categories: [categories.md](https://skilld.dev/api/skills-raw/pingdotgg/t3code/jsdocs/categories.md);
   - examples: [examples.md](https://skilld.dev/api/skills-raw/pingdotgg/t3code/jsdocs/examples.md).
3. Make a focused API fix or module refinement. Preserve verified facts and
   valuable examples rather than rewriting mechanically.
4. For module refinement or APIs with close alternatives, audit `@see` links
   and inspect implementation and tests for concrete `**Gotchas**`.
5. Run `pnpm jsdocs --check` and every applicable root validation command.

`@internal` declarations and default exports are outside public JSDoc
authoring. Checked files do not support exported enums or empty export
declarations.

Public declarations use a multiline block with one self-contained practical
description paragraph. Start functions and methods with a present-tense action;
match nearby noun-family phrasing for values. Optional non-empty sections appear
once in this order: `**When to use**`, `**Details**`, `**Gotchas**`. Separate
descriptions, sections, examples, and tags with one blank line. `**When to
use**` states a positive use case distinct from the description; reserve
`**Gotchas**` for concrete caveats and failure modes.

The task is complete when every changed public declaration satisfies each
applicable reference, the checker passes, runnable examples pass their targeted
doctest, and all other applicable root checks pass or are reported as not run.
