Prompts users to confirm overwriting files.
npx skills add https://github.com/phant-app/phant --skill go-documentation-phant-app
Please help me install this Agent Skill. Skill: go-documentation Source: https://github.com/phant-app/phant/tree/main/.agents/skills/go-documentation Command: npx skills add https://github.com/phant-app/phant --skill go-documentation-phant-app
Go projects often struggle with inconsistent and unclear documentation, leading to onboarding bottlenecks and maintenance challenges. This skill provides structured guidelines for doc comments, package docs, godoc formatting, runnable examples, and signal-boosting to ensure readable and reliable Go documentation.
Review a Go package and align its documentation with these guidelines to improve readability and maintainability.
High-intent search queries and answers about installing and using this skill.
Doc comments for exported Go functions should start with the function name as a complete sentence, describing its behavior clearly. Following these conventions ensures consistency and improves readability across the codebase.
Package-level documentation in Go should be placed in a doc.go file or above the package clause. It should provide a clear overview of the package's purpose and usage, adhering to godoc formatting norms.
Runnable examples in Go are added by creating functions named Example in test files. These examples are formatted and displayed in godoc, demonstrating actual API usage that can be executed directly.
Yes, these documentation guidelines apply to Go codebases of varying sizes. They provide structured standards for doc comments and formatting, ensuring maintainability and easier onboarding for large projects.
Consistent Go documentation matters because it establishes clear norms for sentence structure and capitalization. This consistency enables easier code reviews by reducing cognitive load and ensuring reliable, readable documentation.
muratmirgunIdentify missing or weak godoc for exported Go APIs and examples.
HadiCherkaouiStandardize Go doc comments, package docs, and godoc formatting.
mrlorentxGuide Go testing with stretchr/testify assertions, mocks, and suites.
JSai23Generate and update code documentation from docstrings across Python, Rust, TypeScript, and Go projects.
