Identify missing or weak godoc for exported Go APIs and examples.
npx skills add https://github.com/muratmirgun/gophers --skill go-documentation-muratmirgun
Please help me install this Agent Skill. Skill: go-documentation Source: https://github.com/muratmirgun/gophers/tree/main/skills/go-documentation Command: npx skills add https://github.com/muratmirgun/gophers --skill go-documentation-muratmirgun
This Skill helps you write and review Go documentation that actually improves API usability, rather than repeating code signatures or leaving exported symbols undocumented.
Ask the skill to review your Go package documentation and tell you which exported names, examples, and README sections need to be added or fixed.
High-intent search queries and answers about installing and using this skill.
To ensure proper godoc comments for Go exported APIs, review exported packages, types, functions, methods, constants, variables, and sentinel errors to verify each has a proper comment following Go conventions. This documentation coverage aligns with Go tooling requirements verified by go doc.
The best way to write runnable Example tests for a Go package is to create verified output examples that stay accurate and executable. This ensures your documentation presents minimal runnable examples that pass documentation structure verification via go test.
Structuring README and project documentation for a Go CLI application requires adapting guidance based on whether the repository is a library, CLI, or both. This includes establishing README, CONTRIBUTING, and CHANGELOG expectations that align with Go project conventions.
Go documentation tooling does require package-level comments for exported types to ensure API usability. Proper package summaries and exported symbol comments must be included to satisfy documentation coverage requirements verified by go doc and go test commands.
Go documentation fails to generate properly when exported symbols lack proper comments or contain weak godoc. Missing package comments, undocumented exported APIs, or absent deprecation markers prevent proper documentation structure verification by go doc.
xiaolaiDetect exported identifiers in Go code and enforce godoc-compliant comments for public APIs.
phant-appPrompts users to confirm overwriting files.
pure-golangEnforce doc.go contracts and Russian doc-comments for exported Go symbols.
Andreicr1Generate HTML, Markdown, and PDF API documentation from OpenAPI specs or code comments.
