docs-pr-write

Create and update Tempo documentation pages for user-facing PR changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Writes or updates Tempo documentation pages to reflect user-facing PR changes identified by docs-pr-check, ensuring reviewers and users have accurate guidance.

Core Features & Use Cases

  • Reconstructs capability from each PR and selects the canonical docs target.
  • Writes concise, task-oriented content with runnable examples and version notes.
  • After changes, links updates to related pages and maintains existing page structure for release notes workflows.

Quick Start

Run with the PR numbers to process and the target Tempo branch (for example main or 3.x-docs) to generate and commit the updated docs.

Frequently Asked Questions about docs-pr-write

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

FAQPage Schema
How do I automate Tempo documentation updates for pull request changes?

Tempo documentation updates are automated by detecting user-facing PR changes, selecting canonical docs pages, and writing concise content with runnable examples. The process links related topics and maintains page structure for release notes workflows.

What is the best way to generate runnable examples for Tempo docs from a PR?

Generating runnable examples for Tempo docs requires reconstructing the capability from the PR and verifying against the Tempo codebase. This ensures field names, versions, and links are accurate before committing the updated documentation pages.

How do I select the right canonical Tempo docs page when updating documentation?

Canonical Tempo docs pages are selected by reconstructing the specific capability introduced by the PR changes. The skill matches this capability to the most relevant existing documentation target to ensure accurate content placement.

What do I need to automate Tempo docs writing for pull requests?

Automating Tempo docs writing requires access to docs-pr-check handoff data and the target Tempo branch context, such as main or 3.x-docs. You provide the PR numbers and target branch to generate and commit the updated documentation.

Can I cross-link related Tempo documentation pages after updating content?

Yes, after writing or updating Tempo documentation pages, the process automatically links the updates to related pages. This cross-linking maintains existing page structure and supports release notes workflows for accurate user guidance.