Index of every page on this site: llms.txt
All skills
pingdotgg avatar

/jsdocs

@b5453de
by Ping.ggpingdotgg/t3code67k stars
11,639
Run it yourself

Public API JSDoc. Use when authoring or reviewing Effect API documentation, refining a module's documentation, or fixing documentation related diagnostics.

  • 4 files
  • 7.8 KB
  • Updated 2 months ago
  • GitHub
Use this Skill: https://skilld.dev/gh/pingdotgg/t3code/jsdocs

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈41 tokens for metadata: the name and description. ≈397 when used: this file. ≈1.6k more on demand in 3 files.

Description uses 2.1% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈164 characters, or 2.1%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Workflow

  1. Inspect the declaration, implementation, nearby JSDoc, tests, and call sites.
  2. Select every applicable branch and load its reference before editing:
  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.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at b5453de. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 months ago

README badge

README badge for pingdotgg/t3code/jsdocs