An automated workflow for finding exported code members that lack JSDoc comments, which are documentation comments written next to code. It scans the project, guides the addition of descriptions and parameter and return details, then scans again to verify the result.

Use it to find missing documentation in TypeScript projects, add JSDoc to exported classes and functions, and verify the documentation scan passes.

It removes the need to manually search a codebase for undocumented public functions and classes. Re-running the scanner shows whether the documentation gaps were actually closed.

update-docs — Command for GitHub Copilot by HoangNguyen0403

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Clone the repo

git clone --depth 1 https://github.com/HoangNguyen0403/agent-skills-standard

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/commands/hoangnguyen0403/agent-skills-standard/update-docs/github.svg)](https://agentmods.dev/commands/hoangnguyen0403/agent-skills-standard/update-docs)

Your own site

<a href="https://agentmods.dev/commands/hoangnguyen0403/agent-skills-standard/update-docs"><img src="https://agentmods.dev/badge/commands/hoangnguyen0403/agent-skills-standard/update-docs/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/commands/hoangnguyen0403/agent-skills-standard/update-docs"><img src="https://agentmods.dev/badge/commands/hoangnguyen0403/agent-skills-standard/update-docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 9 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 233 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00009	$0.00233
Opus 5	$0.00005	$0.00117
Sonnet 5	$0.00002	$0.00047
Haiku 4.5	$0.00001	$0.00023

Measured 6d ago against content hash fb5053160b48, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-12, from the pricing page.

Security

Grade A, and why

update-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 6d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/prompts/update-docs.prompt.md · 48 lines

What it actually says

Documentation Update Workflow

This workflow helps you identify and fix missing documentation in the codebase.

1. Run the Documentation Scanner

The scan-docs.ts script identifies exported members that lack JSDoc comments.

pnpm docs:scan

2. Analyze the Report

The script will output a list of files and members missing documentation.

Example output:

⚠️  Found undocumented members:
📄 src/services/MyService.ts
   - class MyService
   - function doSomething

3. Generate Documentation

For each missing item:

Read the code to understand its purpose.
Add JSDoc comments (/** ... */) above the export.
Include:
- Description of what it does.
- @param tags for arguments.
- @returns tag for return value.

4. Verify

Run the scanner again to ensure no items remain.

pnpm docs:scan

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

6d ago First seen · 48 lines · 9 tokens per session scan A fb5053160b48

Subscribe to this mod's changes

update-docs is a command published in the GitHub repository HoangNguyen0403/agent-skills-standard (565 stars, last pushed 3d ago), licensed MIT. It adds 9 tokens to every session and 233 once invoked, about $0.0000 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-06.

React Writing and docs best-practices coding-standards flutter nestjs nextjs

update-docs

Getting it into your agent

Wrote this? Show the measurements

What it costs to keep this loaded

Grade A, and why

Nothing flagged

What it actually says

Documentation Update Workflow

1. Run the Documentation Scanner

2. Analyze the Report

3. Generate Documentation

4. Verify

What this file has done since we first saw it

Other commands, from other repositories

ralph

tools

incident

scan

page

checklist