documentation SKILL.md skillA
documentation from jnpiyush/agentx is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jnpiyush/agentx/documentation@v1.0.0Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jnpiyush/agentx
- Path
.github/skills/development/documentation/SKILL.md- Versions recorded
- 5
- Latest version
- v1.0.0, committed Sep 15, 2026
- First version recorded
- Feb 16, 2026
- Size
- 5,257 bytes
- Repository stars
- 19
- License
- Apache-2.0
Write effective documentation including inline docs, README structure, API documentation, and code comments. Use when writing README files, documenting APIs, creating architecture decision records, adding inline code documentation, or setting up documentation tooling.
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
# Documentation > **Purpose**: Write clear, maintainable documentation for code and APIs. > **Goal**: Self-documenting code, useful comments, comprehensive READMEs. > **Note**: For implementation, see [C# Development](../../languages/csharp/SKILL.md) or [Python Development](../../languages/python/SKILL.md). --- ## When to Use This Skill - Writing or updating README files - Documenting APIs with OpenAPI/Swagger - Creating architecture decision records (ADRs) - Adding inline code documentation - Setting up documentation tooling ## Prerequisites - Markdown formatting knowledge ## Decision Tree ``` Documenting something? +- New project/repo? -> README.md (setup, usage, contributing) +- Public API? | +- REST API -> OpenAPI/Swagger spec | - Library -> XML docs / docstrings on all public members +- Architecture decision? -> ADR (docs/artifacts/adr/ADR-NNN.md) +- Complex logic? | +- WHY it works this way -> Code comment | - HOW to use it -> Doc comment / docstring +- Code self-explanatory? | - Yes -> No comment needed (good naming > comments) - Inline comment? +- Explains WHY (business rule, workaround) -> Keep it - Explains WHAT (obvious from code) -> Remove it ``` …
Read the whole file at its exact version.
How to install
mdr add jnpiyush/agentx/documentation@sha256:1e48fd0e6a75c00cThe line at the top of this page pins the label v1.0.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_avvgyuexq3xqyed7)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Feb 16, 2026 and Sep 15, 2026, about one every 53 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-09-15 | f17c505 | 5,257 B | A | view · diff |
| v1.0.0 | 2026-03-13 | ce01f04 | 5,255 B | A | view · diff |
| v1.0.0 | 2026-03-04 | 848caee | 5,245 B | A | view · diff |
| v1.0.0 | 2026-03-01 | 969f335 | 5,193 B | A | view · diff |
| v1.0.0 | 2026-02-16 | 30e409a | 4,064 B | A | view |
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 (5257 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
jnpiyush/agentx · 19 stars · license Apache-2.0 · pushed 2026-11-04 · branch master
API
GET https://markdownregistry.com/api/v1/artifacts/art_avvgyuexq3xqyed7 GET https://markdownregistry.com/api/v1/resolve?ref=jnpiyush/agentx/documentation GET https://markdownregistry.com/api/v1/blob/1e48fd0e6a75c00c866c05c0a2b14faf2ffa6259bd6096107cf96516d4a2bf8a
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.