Home / jahidulislamseo / antigravity-ai-skills · skills/code-documenter/SKILL.md · GitHub

code-documenter skillA

code-documenter is agent-read markdown (skill) from jahidulislamseo/antigravity-ai-skills: Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides..

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

# Code Documenter

Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.

## When to Use This Skill

Applies to any task involving code documentation, API specs, or developer-facing guides. See the reference table below for specific sub-topics.

## Core Workflow

1. **Discover** - Ask for format preference and exclusions
2. **Detect** - Identify language and framework
3. **Analyze** - Find undocumented code
4. **Document** - Apply consistent format
5. **Validate** - Test all code examples compile/run:
   - Python: `python -m doctest file.py` for doctest blocks; `pytest --doctest-modules` for module-wide checks
   - TypeScript/JavaScript: `tsc --noEmit` to confirm typed examples compile
   - OpenAPI: validate spec with `npx @redocly/cli lint openapi.yaml`
   - If validation fails: fix examples and re-validate before proceeding to the Report step
6. **Report** - Generate coverage summary

## Quick-Reference Examples

### Google-style Docstring (Python)
```python
def fetch_user(user_id: int, active_only: bool = True) -> dict:
    """Fetch a single user record by ID.

    Args:
        user_id: Unique identifier for the user.
…

Read the whole file at its exact version.

How to install

Latest version
mdr add jahidulislamseo/antigravity-ai-skills/code-documenter@v1.1.0
Exact content
mdr add jahidulislamseo/antigravity-ai-skills/code-documenter@sha256:9db40547fcaf2784

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_fwz5xpo5pnijkdga.svg)](https://markdownregistry.com/a/art_fwz5xpo5pnijkdga)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
v1.1.0 latest2026-09-05 84f6bf2 5,496 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 (5496 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

jahidulislamseo/antigravity-ai-skills · 4 stars · license MIT · pushed 2026-09-24 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_fwz5xpo5pnijkdga
GET https://markdownregistry.com/api/v1/resolve?ref=jahidulislamseo/antigravity-ai-skills/code-documenter
GET https://markdownregistry.com/api/v1/blob/9db40547fcaf27844d3b2ca80737bd7e5b94da99094d7f7ca2b27b540b2686f2

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 jahidulislamseo/antigravity-ai-skills

agency-visual-report skill
jahidulislamseo/antigravity-ai-skills · skills/agency-visual-report/SKILL.md · Use when creating ultra-professional, agency-grade client reports, visual HTML dashboards, and executive deliverables…
v1.0.0 · audit A · 4 stars
ahrefs-tool skill
jahidulislamseo/antigravity-ai-skills · skills/ahrefs-tool/SKILL.md · When the user wants backlink analysis, link gap analysis, competitor link profiles, referring domain data, or link…
v1.0.0 · audit A · 4 stars
ai-local-search skill
jahidulislamseo/antigravity-ai-skills · skills/ai-local-search/SKILL.md · When the user wants to optimize for AI-powered local search results including Google AI Overviews, AI Mode, ChatGPT…
v1.0.0 · audit A · 4 stars
angular-architect skill
jahidulislamseo/antigravity-ai-skills · skills/angular-architect/SKILL.md · Generates Angular 17+ standalone components, configures advanced routing with lazy loading and guards, implements NgRx…
v1.1.0 · audit A · 4 stars
api-designer skill
jahidulislamseo/antigravity-ai-skills · skills/api-designer/SKILL.md · Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for…
v1.1.0 · audit A · 4 stars
apple-business-connect skill
jahidulislamseo/antigravity-ai-skills · skills/apple-business-connect/SKILL.md · When the user wants to optimize their Apple Maps listing, set up Apple Business Connect, or improve visibility in…
v1.0.0 · audit A · 4 stars
architecture-designer skill
jahidulislamseo/antigravity-ai-skills · skills/architecture-designer/SKILL.md · Use when designing new high-level system architecture, reviewing existing designs, or making architectural decisions…
v1.1.1 · audit A · 4 stars
atlassian-mcp skill
jahidulislamseo/antigravity-ai-skills · skills/atlassian-mcp/SKILL.md · Integrates with Atlassian products to manage project tracking and documentation via MCP protocol. Use when querying…
v1.1.0 · audit A · 4 stars
bing-places skill
jahidulislamseo/antigravity-ai-skills · skills/bing-places/SKILL.md · When the user wants to optimize their Bing Maps listing, set up Bing Places for Business, or improve visibility in…
v1.0.0 · audit A · 4 stars
brief skill
jahidulislamseo/antigravity-ai-skills · skills/brief/SKILL.md · Manages persistent work state (briefs) for local SEO engagements. Automatically load this skill when starting work on a…
v3.0.0 · audit A · 4 stars
brightlocal-tool skill
jahidulislamseo/antigravity-ai-skills · skills/brightlocal-tool/SKILL.md · When the user wants citation audits, citation building, review monitoring across platforms, GBP audit scoring, or…
v1.0.0 · audit A · 4 stars
chaos-engineer skill
jahidulislamseo/antigravity-ai-skills · skills/chaos-engineer/SKILL.md · Designs chaos experiments, creates failure injection frameworks, and facilitates game day exercises for distributed…
v1.1.0 · audit A · 4 stars

Every file in jahidulislamseo/antigravity-ai-skills

Other files named code-documenter

code-documenter skill
zebbern/claude-code-guide · skills/code-documenter/SKILL.md · Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger…
v1.0.0 · audit A · 4,634 stars
code-documenter skill
zacklecon/claude-skills · skills/code-documenter/SKILL.md · Use when adding docstrings, creating API documentation, or building documentation sites. Invoke for OpenAPI/Swagger…
v1.0.0 · audit A · 3 stars

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