code-documenter SKILL.md skillA
code-documenter from jahidulislamseo/antigravity-ai-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jahidulislamseo/antigravity-ai-skills/code-documenter@v1.1.0Pins v1.1.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jahidulislamseo/antigravity-ai-skills
- Path
skills/code-documenter/SKILL.md- Versions recorded
- 1
- Latest version
- v1.1.0, committed Sep 5, 2026
- Size
- 5,496 bytes
- Repository stars
- 4
- License
- MIT
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.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file 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
mdr add jahidulislamseo/antigravity-ai-skills/code-documenter@sha256:9db40547fcaf2784The line at the top of this page pins the label v1.1.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_fwz5xpo5pnijkdga)
6 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Sep 5, 2026.
Audit of the latest version
- 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
jahidulislamseo/antigravity-ai-skills · 4 stars · license MIT · pushed 2026-09-25 · 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 AI assistant 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.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from jahidulislamseo/antigravity-ai-skills
Every file in jahidulislamseo/antigravity-ai-skills