docs-workflow

Automate GitHub PR documentation workflows for Grafana Tempo across branches.

5.4k|739|Updated Jan 24, 2020
One-click install
npx skills add https://github.com/grafana/tempo --skill docs-workflow-grafana
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-workflow
Source: https://github.com/grafana/tempo/tree/main/.claude/skills/docs-workflow
Command: npx skills add https://github.com/grafana/tempo --skill docs-workflow-grafana

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Grafana Tempo documentation often lags behind PR changes. This workflow provides a structured, end-to-end process to check, write, and review PR documentation, ensuring changes are captured and validated before merging.

Core Features & Use Cases

  • Three-step pipeline: Check — identify gaps, Write — generate/update docs, Review — quality check.
  • PR context awareness: Accepts PR numbers and a target branch to align docs with release contexts.
  • Cross-skill integration: Leverages existing skills for doc checks, writing, and reviews, enabling seamless automation.
  • Handoff and governance: Produces PR-to-doc mappings and prompts for final review decisions.

Quick Start

Invoke with /docs-workflow and provide one or more PR numbers and a target branch such as main or release-2.x.

Frequently Asked Questions about docs-workflow

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

FAQPage Schema
How do I automate documentation updates for Grafana Tempo PRs?▼

You can automate documentation updates for Grafana Tempo PRs by invoking a workflow that coordinates gap analysis, document generation, and quality review across main or release branches, producing PR-to-doc mappings to ensure changes are captured before merging.

What is the best way to check for documentation gaps before merging a pull request?▼

The best way to check for documentation gaps is using a three-step pipeline that identifies missing docs, generates or updates content, and validates quality, ensuring PR changes are fully documented and reviewed before merge.

Can I generate PR documentation for specific release branches like release-2.x?▼

Yes, you can generate PR documentation for specific release branches like release-2.x. The workflow accepts a target branch parameter to align documentation generation and validation with the correct release context.

Does the documentation workflow support multiple PR numbers at once?▼

Yes, the documentation workflow supports multiple PR numbers at once. You provide one or more PR numbers and a target branch, and the workflow automates gap analysis, writing, and review for each PR.

How does the PR documentation review process work?▼

The PR documentation review process works by applying a three-step pipeline that checks for gaps, writes or updates docs, and performs a quality review, culminating in prompts for final review decisions and PR-to-doc mappings.