mcpField
K
k6-docs

k6-docs

github.com/grafanaDevelopment2954.3k installsUpdated 1d ago
Repository

About k6-docs

A Skill for writing or reviewing documentation across k6-DefinitelyTyped, k6-docs, and k6. It supports work on types, user documentation, and release notes, with workflow references and requirements for validating code examples.

Key features

  1. 01Write or review documentation
  2. 02Work across three k6 repositories
  3. 03Use workflow guides and quick references
  4. 04Validate code examples
  5. 05Do not push without approval

Use cases

  1. 01Write k6 user documentation
  2. 02Review k6 feature documentation
  3. 03Update release notes and validate examples

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/grafana/skills --skill k6-docs

After installing, type/k6-docsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
agent-browser-reference.md
repository-structure.md
subagent-prompts.md
testing-workflow.md
troubleshooting.md
typescript-patterns.md
references/checklists/
documentation.md
release-notes.md
typescript.md
references/templates/
documentation.md
release-notes.md
references/workflows/
review.md
write.md
scripts/
check_agent_browser.sh
fetch_pr.sh
find_branch.sh
format_typescript.sh
test_typescript.sh
update_team_members.sh
validate_links.sh

Details

From the project README

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:

Quick References

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:

# 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 master
git 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.

Comments

Markdown supported