Enforce Go documentation best practices across packages, types, and functions.
npx skills add https://github.com/rondevz/phant --skill go-documentation-rondevz
Please help me install this Agent Skill. Skill: go-documentation Source: https://github.com/rondevz/phant/tree/main/.agents/skills/go-documentation Command: npx skills add https://github.com/rondevz/phant --skill go-documentation-rondevz
Go projects often struggle with maintaining consistent, high-quality documentation across packages, types, and functions.
Review a Go package and add clear doc comments, runnable examples, and proper package documentation to meet Go style guidelines.
High-intent search queries and answers about installing and using this skill.
To write Godoc-compliant Go documentation, ensure all exported identifiers have doc comments starting with the identifier name and ending with punctuation. Package comments should provide package-level documentation using proper Godoc formatting conventions.
Go package comments and doc comments must start with the name of the element being documented and end with a period. Complete sentences are required for clarity, and package-level documentation needs to summarize the package's purpose according to Go style conventions.
Runnable examples in a Go package are added as example functions that compile and demonstrate usage. They must be executable to pass example verification, showing users exactly how to interact with the package's exported functions and types.
Yes, you can enforce Go documentation standards during code reviews or CI by checking for complete doc comments on exported identifiers, package documentation, and runnable examples. This ensures all Godoc formatting and style requirements are met automatically.
Go code reviews fail on missing doc comments when exported packages, types, or functions lack proper documentation. Enforcing doc comment norms requires every exported identifier to have a clear comment starting with its name to satisfy Go style guidelines.
Go documentation best practices require runnable examples that compile and demonstrate usage for packages. While not every single exported function needs an example, providing runnable examples ensures the package's functionality is verified and clearly demonstrated.
leogallegoScaffold Ansible execution environment projects with dependency files and CI/CD pipelines.
Rory-XPublish built Slidev presentations to Vercel or GitHub Pages.
zajcaConfigure golangci-lint with recommended Go linters for static analysis.
JansenAnalyticsGenerate README, JSDoc comments, and API documentation from codebases.
