Audit: complete required human-facing README sections across skills #93

New issue

Closed

opened 2026-07-11 09:18:33 -04:00 by magnus · 0 comments

magnus commented

2026-07-11 09:18:33 -04:00

Owner

Finding

AGENTS.md requires every skill README.md to contain a title, Why Install This Skill, What You Get, Quick Start unless genuinely reference-only, Triggers, and Requirements. A strict heading audit found missing required sections in 30 of the 61 skills.

Affected skills

agent-council lacks Why Install This Skill, What You Get, Triggers, and Requirements. data-scientist lacks Why Install This Skill, What You Get, and Quick Start. crewai, dspy, haystack, langchain, and llamaindex lack one or more routing or Quick Start sections. The remaining affected skills are autogen, brand-designer, bundles/tailscale, bundles/workflow-architect, cli-builder, color-management, crowdsec, data-architect, epub, github-runner, hugo-theme, jira-jql, kanban-guru, nous-branding, open-knowledge-format, opensource-contributions, product-discovery, pydanticai, software-architecture-analysis, spec-driven-development, systematic-debugging, and traefik.

Acceptance criteria

Add the required human-facing sections to every affected README, preserving concise human-oriented language.
A reference-only exception must be explicit and documented in the README; otherwise include an actionable Quick Start.
Ensure What You Get accurately lists scripts, templates, and references that exist.
Add a repository check for README presence and required headings.

## Finding AGENTS.md requires every skill README.md to contain a title, Why Install This Skill, What You Get, Quick Start unless genuinely reference-only, Triggers, and Requirements. A strict heading audit found missing required sections in 30 of the 61 skills. ## Affected skills agent-council lacks Why Install This Skill, What You Get, Triggers, and Requirements. data-scientist lacks Why Install This Skill, What You Get, and Quick Start. crewai, dspy, haystack, langchain, and llamaindex lack one or more routing or Quick Start sections. The remaining affected skills are autogen, brand-designer, bundles/tailscale, bundles/workflow-architect, cli-builder, color-management, crowdsec, data-architect, epub, github-runner, hugo-theme, jira-jql, kanban-guru, nous-branding, open-knowledge-format, opensource-contributions, product-discovery, pydanticai, software-architecture-analysis, spec-driven-development, systematic-debugging, and traefik. ## Acceptance criteria - Add the required human-facing sections to every affected README, preserving concise human-oriented language. - A reference-only exception must be explicit and documented in the README; otherwise include an actionable Quick Start. - Ensure What You Get accurately lists scripts, templates, and references that exist. - Add a repository check for README presence and required headings.

magnus referenced this issue from a pull request that will close it,

2026-07-11 09:25:27 -04:00

fix: resolve skill audit findings #97

magnus closed this issue

2026-07-11 09:25:52 -04:00