mirror of
https://github.com/samber/cc-skills-golang.git
synced 2026-09-11 19:46:44 +03:00
docs: improve prose and sweep the skills (#102)
* docs: cap prose paragraphs at 3 sentences and clarify token budgets CLAUDE.md constrained prose only at whole-file granularity, with three conflicting per-SKILL.md token numbers and a "why" pattern that tempted a second sentence per rule. Add a per-paragraph sentence cap, a budget table clarifying which number measures what, and a mechanical checker (scripts/check_prose_density.py) wired into the "After updating a skill" checklist so verbose paragraphs get caught instead of only whole-file token/line counts. * docs: rewrite prose paragraphs over the new 3-sentence density cap CLAUDE.md now caps standalone prose paragraphs at 3 sentences (scripts/check_prose_density.py). Running it across every skill found 62 flagged paragraphs in 31 skills, dominated by a recurring "library disclaimer" paragraph repeated near-verbatim across 17 library-specific skills. Restructure each flagged paragraph into bullets, a table, or a tightened sentence per CLAUDE.md's Formats guidance, preserving every fact, URL, and cross-reference. Re-scanning the full repo now reports 0 flagged paragraphs across all skills. Bump each touched skill's metadata.version by one patch version. Update README token counts for the 31 touched skills to match. * docs: drop the prose-density checker script The script added mechanical enforcement but no CI wiring, so it never ran anywhere but ad hoc. Keep the 3-sentence prose cap and the clarified token-budget table in CLAUDE.md; drop the script and its two call-outs, renumbering the "After updating a skill" checklist back to a contiguous sequence.
This commit is contained in:
@@ -6,7 +6,7 @@ license: MIT
|
||||
compatibility: Designed for Claude Code, Codex or similar harness, and for projects using Golang.
|
||||
metadata:
|
||||
author: samber
|
||||
version: "1.2.1"
|
||||
version: "1.2.2"
|
||||
openclaw:
|
||||
emoji: "🌐"
|
||||
homepage: https://github.com/samber/cc-skills-golang
|
||||
@@ -40,7 +40,11 @@ paths:
|
||||
|
||||
Treat gRPC as a pure transport layer — keep it separate from business logic. The official Go implementation is `google.golang.org/grpc`.
|
||||
|
||||
This skill is not exhaustive. Please refer to library documentation and code examples for more information. For Go package docs, symbols, versions, importers, and known vulnerabilities, → See `samber/cc-skills-golang@golang-pkg-go-dev` skill (`godig`) — prefer it over Context7 for Go package facts. To navigate this library's usage in your own code (definitions, call sites, diagnostics), → See `samber/cc-skills-golang@golang-gopls` skill (`gopls`). Context7 remains a fallback for docs not indexed on pkg.go.dev.
|
||||
This skill is not exhaustive — refer to library documentation and code examples for more information:
|
||||
|
||||
- For Go package docs, symbols, versions, importers, and known vulnerabilities, → See `samber/cc-skills-golang@golang-pkg-go-dev` skill (`godig`), preferred over Context7 for Go package facts.
|
||||
- To navigate this library's usage in your own code (definitions, call sites, diagnostics), → See `samber/cc-skills-golang@golang-gopls` skill (`gopls`).
|
||||
- Context7 remains a fallback for docs not indexed on pkg.go.dev.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
|
||||
Reference in New Issue
Block a user