k6-docs
Write or review k6 documentation across the three k6 repositories - k6-DefinitelyTyped (TypeScript types), k6-docs (user documentation), and k6 (release notes / changelog). Applies k6 doc style conventions, generates TypeScript type definitions, drafts release notes, and validates examples by running them against k6@master. Use when working on k6 documentation, the k6 changelog, the k6 release notes, k6 API reference, k6 TypeScript types, load testing docs, or when the user asks to write, edit,
Security Assessment
About k6-docs
This skill helps contributors write and review k6 documentation across three repositories: k6-DefinitelyTyped (TypeScript type definitions), k6-docs (user-facing documentation), and k6 (release notes and changelog). It solves the problem of keeping k6 documentation consistent, accurate, and verifiably correct by codifying the project's style conventions, generating TypeScript type definitions, drafting release notes, and validating every code example by running it against k6@master.
The skill routes work through write and review workflows and provides extensive reference material: repository structure and feature-type identification, TypeScript patterns and troubleshooting, a testing workflow using parallel subagents, an agent-browser command reference for visual verification, and checklists for documentation, release notes, and TypeScript. It enforces critical rules such as never pushing automatically, never chaining shell commands with && or semicolons, documenting only user-facing features, using 1. for every numbered list item, and testing every example against the latest master before committing. Helper scripts cover link validation, TypeScript formatting and testing, PR fetching, branch finding, and team-member updates, and the documentation checklist includes a link-validation procedure using curl against a local docs server and screenshot-based visual verification.
It is aimed at k6 maintainers and technical writers documenting load-testing features, API references, and changelogs. The shell operations it describes are development-workflow tasks (running examples with go run, git checkout/pull, curl for HTTP status checks against a local server, screenshotting) that are standard and read-oriented rather than destructive.
FAQ
Which repositories and content does this cover?
Three k6 repos: k6-DefinitelyTyped for TypeScript types, k6-docs for user documentation, and k6 for release notes and changelog. It applies k6 doc style conventions, generates type definitions, drafts release notes, and validates examples.
How are code examples validated?
Every runnable example in documentation and release notes must execute cleanly against k6@master. The minimal loop is to cd into the k6 repo, check out and pull master, then run each example separately with go run . run against the script, fixing and re-running on failure.
What are the critical rules?
Never push automatically (always ask first), never chain commands with && or semicolons (run each separately), document only user-facing features, use 1. for every numbered list item, test every example against k6@master, and add no AI attribution in commits.
How are docs links and rendering checked?
Added links are extracted via a git diff pipeline and checked with curl against a local docs server (localhost:3002), requiring 200 responses. The agent-browser tool takes full-page screenshots to verify tables, syntax highlighting, navigation breadcrumbs, and related links render correctly.
All Files
21 filesInstall k6-docs
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
grafana/skills