Home / cowork-os / cowork-os · resources/skills/add-documentation/SKILL.md · GitHub

add-documentation skillA

add-documentation is agent-read markdown (skill) from cowork-os/cowork-os: Generate JSDoc/docstrings for functions.

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# Add Documentation

## Purpose

Generate JSDoc/docstrings for functions

## Routing

- Use when: Use when users ask for in-code docs, docstring addition, or API-level comments.
- Do not use when: Don't use for content translation or narrative changelogs.
- Outputs: Updated code artifacts with improved inline documentation.
- Success criteria: Retains behavior while improving doc clarity and consistency.

## Trigger Examples

### Positive

- Use the add-documentation skill for this request.
- Help me with add documentation.
- Use when users ask for in-code docs, docstring addition, or API-level comments.
- Add Documentation: provide an actionable result.

### Negative

- Don't use for content translation or narrative changelogs.
- Do not use add-documentation for unrelated requests.
- This request is outside add documentation scope.
- This is conceptual discussion only; no tool workflow is needed.

## Parameters

| Name  | Type   | Required | Description                  |
| ----- | ------ | -------- | ---------------------------- |
| path  | string | Yes      | Path to the file to document |
| style | select | Yes      | Documentation style          |

## Runtime Prompt
…

Read the whole file at its exact version.

How to install

Latest version
mdr add cowork-os/cowork-os/add-documentation@v1.0.0
Exact content
mdr add cowork-os/cowork-os/add-documentation@sha256:08c341c45a4126a9

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_s6osqo3iynfyfi6i.svg)](https://markdownregistry.com/a/art_s6osqo3iynfyfi6i)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
v1.0.0 latest2026-09-19 a74ade5 1,480 BA view · diff
v1.0.02026-08-20 7d5e96f 1,398 BA view · diff
git:20260228.d005bbe2026-02-28 d005bbe 1,315 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (1480 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

cowork-os/cowork-os · 459 stars · license MIT · pushed 2026-09-23 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_s6osqo3iynfyfi6i
GET https://markdownregistry.com/api/v1/resolve?ref=cowork-os/cowork-os/add-documentation
GET https://markdownregistry.com/api/v1/blob/08c341c45a4126a99ea98777b191bf8f0b665dd0b5688f16fe79ac7fa4d5ae55

Your agent does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

More from cowork-os/cowork-os

attack-path-analysis skill
cowork-os/cowork-os · resources/plugin-packs/codex-security/skills/attack-path-analysis/SKILL.md · Use when Codex is already in the attack-path-analysis phase of a security scan or the user explicitly asks to trace a…
git:20260919.4f2a470 · audit A · 459 stars
deep-security-scan skill
cowork-os/cowork-os · resources/plugin-packs/codex-security/skills/deep-security-scan/SKILL.md · Use when the user asks for a deep, exhaustive, multi-pass, or variance-reducing repository-wide Codex Security scan…
git:20260606.a4decec · audit A · 459 stars
finding-discovery skill
cowork-os/cowork-os · resources/plugin-packs/codex-security/skills/finding-discovery/SKILL.md · Use when Codex is already in the finding-discovery phase of a security scan or the user explicitly asks to discover…
git:20260919.ad0495b · audit A · 459 stars
fix-finding skill
cowork-os/cowork-os · resources/plugin-packs/codex-security/skills/fix-finding/SKILL.md · Use when the user explicitly asks to fix and verify a validated or plausible security finding. Do not use as the…
git:20260606.a4decec · audit A · 459 stars
security-diff-scan skill
cowork-os/cowork-os · resources/plugin-packs/codex-security/skills/security-diff-scan/SKILL.md · Use when the user asks for a security review of a pull request, commit, branch diff, working-tree patch, or other…
git:20260919.c03e78b · audit A · 459 stars
security-scan skill
cowork-os/cowork-os · resources/plugin-packs/codex-security/skills/security-scan/SKILL.md · Use when the user asks for a repository-wide or scoped-path security scan.
git:20260919.7b075ca · audit A · 459 stars
threat-model skill
cowork-os/cowork-os · resources/plugin-packs/codex-security/skills/threat-model/SKILL.md · Use when Codex is already in the threat-modeling phase of a security scan, the user explicitly invokes $threat-model…
git:20260606.a4decec · audit A · 459 stars
validation skill
cowork-os/cowork-os · resources/plugin-packs/codex-security/skills/validation/SKILL.md · Use when Codex is already in the validation phase of a security scan or the user explicitly asks to determine whether…
git:20260606.a4decec · audit A · 459 stars
1password skill
cowork-os/cowork-os · resources/skills/1password/SKILL.md · Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or…
v1.0.0 · audit A · 459 stars
agentic-image-loop skill
cowork-os/cowork-os · resources/skills/agentic-image-loop/SKILL.md · Generate -> annotate -> refine -> repeat using generate_image + Visual Annotator (Live Canvas).
v1.0.0 · audit A · 459 stars
analyze-csv skill
cowork-os/cowork-os · resources/skills/analyze-csv/SKILL.md · Load a CSV and provide insights
v1.0.0 · audit A · 459 stars
android-development skill
cowork-os/cowork-os · resources/skills/android-development/SKILL.md · Android/Kotlin development: Jetpack Compose, Room database, Gradle builds, emulator management, and Play Store…
v1.0.0 · audit A · 459 stars

Every file in cowork-os/cowork-os

Browse by kind, by grade A, or by owner.