docs-pr-check

Classify PRs into four documentation categories and generate prioritized gap summaries.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps engineering and documentation teams assess whether PR changes include user-facing docs, and identifies gaps between proposed changes and existing Tempo documentation.

Core Features & Use Cases

  • Classifies PRs into Docs present, Docs needed, Docs update needed, or No docs required.
  • Locates and references relevant docs pages under docs/sources/tempo to validate coverage.
  • Generates a prioritized gap summary and a ready-to-use handoff for docs-pr-write.

Quick Start

Run /docs-pr-check on a curated PR list to classify documentation status and surface gaps.

Frequently Asked Questions about docs-pr-check

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

FAQPage Schema
How do I identify documentation gaps in Tempo pull requests?

To identify Tempo documentation gaps in pull requests, you classify each PR into one of four categories: Docs present, Docs needed, Docs update needed, or No docs required, while cross-referencing existing docs/sources/tempo pages.

What is the best way to audit PR docs for Tempo release notes?

Auditing PR docs for Tempo release notes involves scanning a curated PR list to classify documentation status, validating coverage against existing docs, and generating a prioritized gap summary to highlight missing or required updates.

How do I classify which Tempo PRs need documentation updates?

You classify Tempo PRs by comparing proposed code changes against existing documentation pages under docs/sources/tempo, assigning each PR a status of Docs present, Docs needed, Docs update needed, or No docs required.

Can I automate the handoff for writing missing Tempo documentation?

Yes, after identifying documentation gaps in Tempo PRs, you generate an output format suitable for the docs-pr-write handoff, providing a prioritized summary of required updates for the technical writing team.

When do I need to run a gap analysis on Tempo pull requests?

You need to run a gap analysis on Tempo pull requests when preparing for a release, ensuring all user-facing changes have corresponding documentation updates mapped correctly within the docs/sources/tempo directory structure.

Does the docs-pr-check workflow require dependencies to classify PRs?

No, the docs-pr-check workflow operates without external dependencies, directly analyzing your curated PR list and referencing the existing docs/sources/tempo repository to classify documentation needs.