One-click install
npx skills add https://github.com/ascerra-fullsend-rehearsal/fullsend --skill docs-review-ascerra-fullsend-rehearsal
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/ascerra-fullsend-rehearsal/fullsend/tree/main/internal/scaffold/fullsend-repo/skills/docs-review
Command: npx skills add https://github.com/ascerra-fullsend-rehearsal/fullsend --skill docs-review-ascerra-fullsend-rehearsal

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

The 'docs-review' skill unit automates the evaluation of a pull request's code changes for impact on in-repo documentation. It identifies stale documentation to ensure the latest changes are reflected accurately.

Core Features & Use Cases

  • Code Change Impact Assessment: Matches PR code changes with documentation for drift detection.
  • Documentation Search & Analysis: Searches repository documentation for changes, flagging potentially outdated content.
  • Read-only Operation: Generates findings without updating documentation, allowing manual resolution.

Quick Start

Activate the docs-review skill within the PR review process for documentation staleness evaluation.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How do I detect stale documentation in a GitHub pull request?

To detect stale documentation in a GitHub pull request, you can automate PR documentation staleness detection. The skill analyzes code changes using regex patterns to match changed identifiers against in-repo documentation and flags outdated files.

How does automated documentation review work for code changes?

Automated documentation review works by assessing code change impacts within a pull request. It searches repository documentation for drift, matches changed code identifiers against existing docs, and generates a list of flagged files with suggested severity.

Can I run stale documentation detection without modifying repository files?

Yes, you can run stale documentation detection without modifying files because the skill operates in read-only mode. It evaluates pull request code changes and generates findings of potentially outdated content for manual resolution without updating documentation.

What's the best way to flag outdated in-repo documentation during code review?

The best way to flag outdated in-repo documentation during code review is to automate documentation search and analysis. This approach matches pull request code changes with repository documentation to flag potentially outdated content for review.

Does stale documentation detection automatically update flagged files?

Stale documentation detection does not automatically update flagged files. It operates strictly in read-only mode to identify outdated content, providing a list of flagged files with a suggested severity to allow developers to perform manual resolution.