Lightlines
By cxuu

go-documentation

cxuu1.2k installs

Clear Go API docs, with missing comments caught.

What it does

Guides agents in writing clear Go API documentation and checking exported symbols for missing comments.

When to use it

Use when writing or reviewing Go documentation, and proactively when creating exported types, functions, or packages.

How to use it

It changes how the agent writes and reviews Go documentation, requiring comments on exported names and validation of missing documentation.

What you provide

  • An existing project

Latest review

What you need · 1

Requires the Go toolchain installed and available on PATH to run the documentation checker.


Access · 2

This skill

pkgsite

Execute

Installs the documentation preview tool

Execute

Starts the documentation preview process

~/.cache/golang-skills

Write

Caches the documentation checker locally