k6-docs

Coordinate k6 documentation, TypeScript definitions, and release notes across repositories.

213|18|Updated Mar 17, 2026
One-click install
npx skills add https://github.com/grafana/skills --skill k6-docs-grafana
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: k6-docs
Source: https://github.com/grafana/skills/tree/main/skills/grafana-k6/k6-docs
Command: npx skills add https://github.com/grafana/skills --skill k6-docs-grafana

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires agent-browser, npm, gh, pnpm, jq, curl, git, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Coordinating documentation, TypeScript definitions, and release notes across multiple k6-related repositories is time-consuming and error-prone; this Skill centralizes workflows, checks, and verification steps to reduce mistakes and review overhead. It helps authors and reviewers ensure examples are runnable, links are valid, and type definitions match implementation before changes are merged.

Core Features & Use Cases

  • Guided write and review workflows for k6-docs, k6-DefinitelyTyped, and k6 release notes with explicit steps and checklists.
  • Automated validation helpers: link validation pipeline, visual verification via agent-browser, and test execution of examples against k6@master.
  • TypeScript support: patterns, formatting, and test commands for types/k6, plus scripts to run pnpm test and dprint formatting.
  • Release notes and contributor checks: templates and a script to update and validate team member lists for thanking external contributors.
  • Use case: run a parallel review for a new browser API that launches TypeScript, docs, and release-note checks, validates links, screenshots pages, and tests all runnable examples.

Quick Start

Review the documentation, TypeScript types, and release notes for feature "page.waitForEvent" across k6-docs, k6-DefinitelyTyped, and k6 using the review workflow.

Frequently Asked Questions about k6-docs

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

FAQPage Schema
How do I validate k6 documentation links and test examples before merging?

To validate k6 documentation, run the link validation pipeline and execute examples against k6@master. Visual verification is performed using agent-browser to screenshot pages, ensuring examples are runnable and links are valid before changes are merged.

How do I coordinate TypeScript definitions and release notes across k6 repositories?

To coordinate k6 repositories, apply a centralized workflow across k6-docs, k6-DefinitelyTyped, and k6. This guided process manages TypeScript definition formatting, runs pnpm test, and drafts release notes concurrently to reduce review overhead.

Can I run TypeScript checks and formatting for k6 type definitions?

Yes, you can run TypeScript checks for k6 definitions using pnpm test and dprint formatting. The workflow provides specific patterns and test commands for types/k6 to ensure type definitions match the implementation.

What tools do I need to perform a parallel review of a new k6 browser API?

To perform a parallel review of a k6 browser API, you need agent-browser for visual verification, pnpm for package management, and gh for repository actions. These tools launch TypeScript, docs, and release-note checks simultaneously.

Are there limitations when running shell commands for k6 documentation checks?

Yes, a key limitation is that checklist rules prohibit chaining shell commands. Additionally, the workflow requires manual push approval before changes are applied, ensuring strict oversight during k6 documentation and TypeScript reviews.