docs

Review and update gokit documentation for style, accuracy, and readability.

Updated Feb 15, 2026
One-click install
npx skills add https://github.com/kbukum/gokit --skill docs-kbukum
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/kbukum/gokit/tree/main/.github/skills/docs
Command: npx skills add https://github.com/kbukum/gokit --skill docs-kbukum

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation goes stale in two ways: it drifts from style rules (hard-wrapped prose, dead links, history narration) and it stops matching the actual code (renamed commands, changed module structure, broken examples). This Skill sweeps both problems across the entire gokit doc surface. ## Core Features & Use Cases - Standards pass: Repairs AI-generated hard wraps, removes history/plan narration, and preserves intentional Markdown structure like tables, lists, and mermaid diagrams. - Accuracy pass: Verifies docs against the real codebase — Makefile targets, module lists in PACKAGES.md and MODULE-INDEX.md, go.work membership, and compilable examples. - Clarity pass: Rewrites prose for scannability with task-first ordering, plain language, runnable examples, and mermaid diagrams where they clarify architecture. - Use Case: Before a release, run the Skill over the whole docs/ tree to sync commands, fix stale links, and commit the result as a clean docs: Conventional Commit. ## Quick Start Ask the AI to review and update the gokit documentation in docs/ so it matches the current code and follows the doc style rules.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix hard-wrapped Markdown paragraphs?▼

Collapse source newlines only within the same logical paragraph so each paragraph is one continuous line. Preserve blank-line boundaries, list items, tables, code blocks, and semantic breaks like <br> or two trailing spaces.

How do I keep documentation in sync with code changes?▼

Verify each doc against the code it describes: check Makefile targets still exist, module lists match go.work membership, examples compile, and internal links resolve. Run go vet on packages whose doc.go changed.

What documentation files does this Skill cover?▼

It covers docs/**, top-level Markdown like README.md and CHANGELOG.md, SKILL.md files and their references, plus doc.go and Go comments. It never touches the gitignored tmp/ directory.

When should I add a mermaid diagram to documentation?▼

Add a mermaid diagram when explaining architecture, dependency direction, request flows, or state machines where prose would force the reader to assemble the picture mentally. Keep each diagram to one idea with a one-line caption.

What validation is needed after editing documentation?▼

Prose-only changes need no build gate. If a doc.go file changed, run go vet on that package to confirm it still compiles, and verify internal links by path before committing.