go-docs SKILL.md skillA
go-docs from bitwise-media-group/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add bitwise-media-group/skills/go-docs@git:20260701.20789e5Pins git:20260701.20789e5 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- bitwise-media-group/skills
- Path
plugins/golang/skills/go-docs/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260701.20789e5, committed Jul 1, 2026
- First version recorded
- Jun 10, 2026
- Size
- 3,932 bytes
- Repository stars
- 3
- License
- MIT
Go documentation conventions — a doc comment on every exported function, struct, type, and package, package comments in a dedicated doc.go for multi-file packages, godoc style (complete sentences beginning with the identifier's name), and LLM-ready CLI reference generation for cobra tools via a docgen helper built on cobra/doc. Use when writing or reviewing doc comments or godoc in Go code, adding a doc.go or writing a package comment for a Go package, documenting an exported Go API, package…
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
# Go documentation conventions
Doc comments are the API's reference manual: godoc, pkg.go.dev, and editors render them, and LLM
coding agents read them to learn an API. These rules say where they go and what they look like;
for the code itself see the `go-style` skill.
## 1. Every exported identifier gets a doc comment
Every exported function, method, struct and other type, interface, and package-level const or var
(or grouped block) carries a doc comment — no exceptions for "obvious" ones. The comment is a
complete sentence that begins with the identifier's name and states what the caller may rely on:
```go
// Parse splits a KEY=VALUE line into its key and value, trimming whitespace
// around both. It returns an error when the separator is missing.
func Parse(line string) (key, value string, err error) {
```
- Start with the name: `// Loader reads …`, never `// This function reads …`.
- Document behavior and invariants, not implementation — what holds true for the caller.
- Mark deprecations with a `Deprecated:` paragraph so tooling can flag callers.
## 2. Package comments live in doc.go
…Read the whole file at its exact version.
How to install
mdr add bitwise-media-group/skills/go-docs@sha256:5466f1cba7591ed5The line at the top of this page pins the label git:20260701.20789e5, 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_roql3vemptkytfts)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Jun 10, 2026 and Jul 1, 2026, about one every 21 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260701.20789e5 latest | 2026-07-01 | 20789e5 | 3,932 B | A | view · diff |
| git:20260610.bbb9f8d | 2026-06-10 | bbb9f8d | 3,837 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 (3932 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
bitwise-media-group/skills · 3 stars · license MIT · pushed 2026-10-21 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_roql3vemptkytfts GET https://markdownregistry.com/api/v1/resolve?ref=bitwise-media-group/skills/go-docs GET https://markdownregistry.com/api/v1/blob/5466f1cba7591ed57544a7fc08f133c3ca9ba21bd818dd19824dcb2258c68c78
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.