K6 Docs

by grafana1ccacf29049fApache-2.0279 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated today

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, or review anything in the k6, k6-docs, or k6-DefinitelyTyped repos - even if they don't explicitly say "documentation".

AI-generated overview

Writes and reviews k6 documentation, TypeScript type definitions, and release notes across three k6 repositories.

What it does
This skill guides an agent through writing or reviewing k6 documentation in the k6-DefinitelyTyped, k6-docs, and k6 repositories. It applies k6 documentation style conventions, drafts release notes and changelogs, generates TypeScript type definitions, and validates code examples by running them against k6@master. It ships reference material, checklists, templates, and shell scripts for fetching pull requests, locating branches, formatting and testing TypeScript, validating links, and updating team members.
When to use it
Use it when working on k6 documentation, the k6 changelog or release notes, the k6 API reference, or k6 TypeScript types. It also fits requests to write, edit, or review anything in the k6, k6-docs, or k6-DefinitelyTyped repositories, even when documentation is not explicitly mentioned.
Requirements
Requires a local checkout of the k6 repository on master, the Go toolchain to run examples with go run, and shell access for the bundled scripts. Some scripts may need network access and credentials for repository operations such as fetching pull requests.

k6 Documentation

Document or review k6 features across three repositories: k6-DefinitelyTyped (TypeScript types), k6-docs (user documentation), and k6 (release notes).

Workflow

Pick the workflow that matches the user's intent:

  • Write documentation: follow references/workflows/write.md [blocked]
  • Review documentation: follow references/workflows/review.md [blocked]

Quick References

  • Repository structure & feature type identification [blocked]
  • TypeScript patterns & troubleshooting [blocked]
  • Testing workflow with parallel subagents [blocked]
  • agent-browser command reference [blocked]
  • Troubleshooting guide [blocked]

Critical Rules

  • Never push automatically - always ask first
  • Never chain commands with && or ; - run each command separately (prevents failures)
  • Only document user-facing features - not internal implementation
  • Use 1. for every numbered list item (not 1., 2., 3.)
  • Test every code example against k6@master before committing
  • No Co-Authored-By: Claude or AI attribution in commits

Validating examples (always run before committing)

Every code example in k6 documentation and release notes must execute cleanly against k6@master. The minimum loop:

bash
# 1. cd into the k6 repo (not k6-docs or k6-DefinitelyTyped)cd ~/path/to/k6
# 2. Make sure you're on master at the latest commit (the contract is k6@master)git checkout mastergit pull
# 3. Run each example as a separate command (no &&)go run . run /path/to/script.js

If the run fails: read the error, fix the example in the source (doc or release note), re-run. Do not commit a change whose example doesn't run clean against current master. For the full multi-example workflow with parallel subagents, see references/testing-workflow.md [blocked].

Source and attribution

Source:grafana/skillsinskills/grafana-k6/k6-docsat commit1ccacf2

License: Apache-2.0

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

More from grafana/skills

React 19 Plugin Migration

grafana

Guides migration of a Grafana plugin to React 19 compatibility through ordered build, dependency and source-code steps.

Software Development279updated today

Plugin Bundle Size

grafana

Guides optimisation of Grafana app plugin bundle size using React.lazy, Suspense and webpack code splitting.

Software Development279updated today

Grafana Scenes

grafana

Builds Grafana plugin pages with the @grafana/scenes framework, covering scenes, panels, variables and drilldowns.

Software Development279updated today

Check Npm

grafana

Read-only audit of npm, yarn, or pnpm configuration for supply-chain hardening in a JS/TS repository.

Security279updated today

Mimir

grafana

Guides standing up and operating Grafana Mimir for scalable, multi-tenant, long-term Prometheus and OTLP metrics storage.

DevOps & Cloud279updated today

K6 Trend Analysis

grafana

Analyze Grafana Cloud k6 test run trends over time. Detects slow metric drift (e.g., P95 latency creeping up while still passing thresholds), computes headroom to thresholds, flags anomalies, and recommends threshold tightening. Use when the user asks about test performance trends, wants to know if metrics are degrading, asks whether thresholds should be tightened, or wants a health check across recent runs for a specific test. Trigger on phrases like "how is my test trending", "is P95 getting worse", "check for performance regression", "should I tighten thresholds", "are my tests degrading", "show me trends for test X", "analyze my k6 test runs", or "is my test getting slower". Also trigger when a user asks to check all tests in a project -- run this skill once per test and synthesize.

Awaiting classification279updated today