phoenix-docs-gap-audit

Audit recent commits against all Phoenix documentation surfaces to produce a grounded gap report.

11.3k|1.1k|Updated Nov 9, 2022
One-click install
npx skills add https://github.com/Arize-ai/phoenix --skill phoenix-docs-gap-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: phoenix-docs-gap-audit
Source: https://github.com/Arize-ai/phoenix/tree/main/.agents/skills/phoenix-docs-gap-audit
Command: npx skills add https://github.com/Arize-ai/phoenix --skill phoenix-docs-gap-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Features ship in the Phoenix repo every week without matching documentation, and stale docs silently teach users wrong APIs. This Skill systematically finds what shipped without docs so maintainers know exactly what to write and where.

Core Features & Use Cases

  • Commit triage and analysis: Fetches commits from origin/main over a configurable window, classifies them as user-facing, skippable, or unclear, and reads diffs to uncover hidden public surface changes.
  • Multi-surface doc coverage checks: Cross-references every public surface against Mintlify docs, package READMEs, Sphinx and TypeDoc sources, Python docstrings, TSDoc, env var docs, and onboarding snippets.
  • Classified gap report: Produces a markdown report labeling each gap as Missing, Stale, Incomplete, or Missing rationale with severity, verified file paths, line numbers, and code-grounded proposed content.
  • Use Case: Ask what landed last week that needs docs, and receive a complete report listing each undocumented feature, the exact doc surfaces it is missing from, and verified example snippets ready to hand to a docs writer.

Quick Start

Audit the Phoenix repo for documentation gaps from the last 7 days of commits on origin/main and produce a gap report.

Frequently Asked Questions about phoenix-docs-gap-audit

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

FAQPage Schema
How do I find undocumented features in recent commits?

Run the audit against origin/main with a time window such as the last 7 days. The skill fetches commits, triages user-facing changes, greps every doc surface for coverage, and outputs a gap report listing what is missing, stale, or incomplete.

What documentation surfaces does the audit check?

It checks Mintlify pages under docs/phoenix, server and package READMEs, Sphinx sources for Python packages, TypeDoc and TSDoc for TypeScript packages, Python docstrings, env var documentation, llms.txt, and in-product onboarding snippets.

Can I audit a specific release range instead of the last 7 days?

Yes. The default window is 7 days on origin/main, but you can specify a tag range, a release boundary, or a custom period, and the skill translates that phrasing into a concrete git log range before auditing.

Does the audit flag feature flags as missing documentation?

No. Internal feature flags such as env vars named with DANGEROUSLY or EXPERIMENTAL prefixes are deliberately undocumented and skipped. If such a flag appears in public docs, the audit flags that as a gap in the opposite direction.

Why does the audit use origin/main instead of local main?

Local main branches are routinely stale by dozens of commits in active repos, which would silently miss recently shipped features. The skill fetches origin first and audits origin/main so the report reflects what actually shipped.