Add concise JSDoc to exported JavaScript and TypeScript APIs.
npx skills add https://github.com/howells/skills --skill marginalia
Please help me install this Agent Skill. Skill: marginalia Source: https://github.com/howells/skills/tree/main/marginalia Command: npx skills add https://github.com/howells/skills --skill marginalia
Marginalia removes the guesswork in JavaScript/TypeScript codebases by adding concise, IDE-friendly JSDoc exactly where it matters most: public APIs and complex behavior.
Use the marginalia skill to add concise JSDoc to the exported functions in a TypeScript package’s public API surface, without changing behavior.
High-intent search queries and answers about installing and using this skill.
Adding JSDoc to exported TypeScript functions involves reading implementation and usage to generate high-signal comments for public APIs. This ensures IDE hovers and generated documentation accurately reflect real behavior and constraints without changing the underlying code.
The best way to document React component hooks and complex generics is to infer the documentation target and read relevant implementation. This adds brief JSDoc describing callback contracts, side effects, and async behavior while keeping comment density minimal and useful.
Yes, you can generate API documentation for public package exports without stale comments by reading relevant implementation and usage first. This approach avoids guesswork and chooses the smallest effective documentation density to match actual constraints.
No, adding JSDoc to public APIs does not require modifying existing code behavior. The process strictly adds documentation comments to exported symbols across modules and validates them via existing repo tooling, leaving the implementation untouched.
You should avoid adding JSDoc when it results in documentation theater. If the implementation cannot support concise, high-signal comments that satisfy IDE hover quality and runtime constraints, adding unnecessary comments increases maintenance without value.
mikecubedDetect missing JSDoc, docstrings, and READMEs across five languages.
DanielPodolskyStandardize software documentation with README, JSDoc, and inline comment guidelines.
agentscope-aiExtract signatures and documentation from AgentScope modules using Python's inspect module.
j0KZGenerate READMEs, changelogs, and API docs from TypeScript sources.
