agentsclimarketplace

Go docs

Skill nyquistwilder/personal-pi/skills/go-docs

My personal pi harness configuration.

Install
npx -y skills add nyquistwilder/personal-pi --skill go-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Go documentation workflow for README, package comments, Go doc examples, CLI help, HTTP API contracts, architecture notes, and keeping docs synchronized with greenfield behavior.

SKILL.md

1.7 KB, as published. Nobody here has run it

Go Docs

Rule

Document behavior that users and maintainers need. Prefer runnable examples and package docs that stay close to code.

Hard Stops

Ask before:

  • Documenting unsupported behavior or changing public contracts only to match docs.
  • Adding documentation site generators, badges, hosting, diagrams-as-code tooling, or API generators.
  • Publishing docs externally or changing versioned docs.

Defaults

  • Use README for project usage, development commands, and operational notes.
  • Use package comments in doc.go or primary package files for exported packages.
  • Add doc comments for exported identifiers; keep them accurate and concise.
  • Use ExampleXxx tests for public API examples when useful.
  • Keep CLI help generated by the CLI itself where possible.
  • Keep HTTP API docs tied to route/schema contracts; add OpenAPI tooling only when approved.

Workflow

  1. Inspect code, tests, README, package docs, examples, and generated help/API docs.
  2. Update docs near the behavior changed.
  3. Add runnable examples or smoke tests when docs include executable snippets.
  4. Run go test ./... to validate examples and just check when available.

Antipatterns

  • README examples that cannot run or use stale flags.
  • Exported Go symbols without comments in public libraries.
  • Duplicating API contracts in multiple files without a source of truth.
  • Documenting implementation details as stable guarantees.

Completion

Report docs changed, examples tested, behavior verified, and remaining gaps.

Keep looking

Skills are one crate of 328,083. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.